From 2b7fe38c36cdf69428039c4bafbf47be15b807fa Mon Sep 17 00:00:00 2001 From: Akim Demaille Date: Tue, 8 Oct 2013 13:01:24 +0200 Subject: [PATCH] comment changes * src/complain.h, src/complain.c: More documentation, more comments. --- src/complain.c | 13 ++++++++----- src/complain.h | 12 ++++++------ 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/src/complain.c b/src/complain.c index fdc4b542..d2f3f4a2 100644 --- a/src/complain.c +++ b/src/complain.c @@ -38,11 +38,11 @@ bool warnings_are_errors = false; /** Diagnostics severity. */ typedef enum { - severity_disabled = 0, - severity_unset = 1, - severity_warning = 2, - severity_error = 3, - severity_fatal = 4 + severity_disabled = 0, /**< Explicitly disabled via -Wno-foo. */ + severity_unset = 1, /**< Unspecified status. */ + severity_warning = 2, /**< A warning. */ + severity_error = 3, /**< An error (continue, but die soon). */ + severity_fatal = 4 /**< Fatal error (die now). */ } severity; @@ -151,7 +151,10 @@ warnings_argmatch (char *args) } else { + // The length of the possible 'no-' prefix: 3, or 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; warning_argmatch (args, no, err); diff --git a/src/complain.h b/src/complain.h index 0d81503d..62dd8fad 100644 --- a/src/complain.h +++ b/src/complain.h @@ -128,14 +128,14 @@ void deprecated_directive (location const *loc, void duplicate_directive (char const *directive, location first, location second); -/** Warnings treated as errors shouldn't stop the execution as regular errors - should (because due to their nature, it is safe to go on). Thus, there are - three possible execution statuses. */ +/** Warnings treated as errors shouldn't stop the execution as regular + errors should (because due to their nature, it is safe to go + on). Thus, there are three possible execution statuses. */ typedef enum { - status_none, - status_warning_as_error, - status_complaint + status_none, /**< No diagnostic issued so far. */ + status_warning_as_error, /**< A warning was issued (but no error). */ + status_complaint /**< An error was issued. */ } err_status; /** Whether an error was reported. */ -- 2.45.2