comment changes

* src/complain.h, src/complain.c: More documentation, more comments.
This commit is contained in:
Akim Demaille
2013-10-08 13:01:24 +02:00
parent 4c4191cec2
commit 2b7fe38c36
2 changed files with 14 additions and 11 deletions

View File

@@ -38,11 +38,11 @@ bool warnings_are_errors = false;
/** Diagnostics severity. */ /** Diagnostics severity. */
typedef enum typedef enum
{ {
severity_disabled = 0, severity_disabled = 0, /**< Explicitly disabled via -Wno-foo. */
severity_unset = 1, severity_unset = 1, /**< Unspecified status. */
severity_warning = 2, severity_warning = 2, /**< A warning. */
severity_error = 3, severity_error = 3, /**< An error (continue, but die soon). */
severity_fatal = 4 severity_fatal = 4 /**< Fatal error (die now). */
} severity; } severity;
@@ -151,7 +151,10 @@ warnings_argmatch (char *args)
} }
else else
{ {
// The length of the possible 'no-' prefix: 3, or 0.
size_t no = STRPREFIX_LIT ("no-", args) ? 3 : 0; size_t no = STRPREFIX_LIT ("no-", args) ? 3 : 0;
// The length of the possible 'error=' (possibly after
// 'no-') prefix: 6, or 0.
size_t err = STRPREFIX_LIT ("error=", args + no) ? 6 : 0; size_t err = STRPREFIX_LIT ("error=", args + no) ? 6 : 0;
warning_argmatch (args, no, err); warning_argmatch (args, no, err);

View File

@@ -128,14 +128,14 @@ void deprecated_directive (location const *loc,
void duplicate_directive (char const *directive, void duplicate_directive (char const *directive,
location first, location second); location first, location second);
/** Warnings treated as errors shouldn't stop the execution as regular errors /** Warnings treated as errors shouldn't stop the execution as regular
should (because due to their nature, it is safe to go on). Thus, there are errors should (because due to their nature, it is safe to go
three possible execution statuses. */ on). Thus, there are three possible execution statuses. */
typedef enum typedef enum
{ {
status_none, status_none, /**< No diagnostic issued so far. */
status_warning_as_error, status_warning_as_error, /**< A warning was issued (but no error). */
status_complaint status_complaint /**< An error was issued. */
} err_status; } err_status;
/** Whether an error was reported. */ /** Whether an error was reported. */