]> git.tue.mpg.de Git - paraslash.git/commitdiff
Exclude status items and error list from doxygen.
authorAndre Noll <maan@tuebingen.mpg.de>
Sun, 2 Oct 2022 22:33:59 +0000 (00:33 +0200)
committerAndre Noll <maan@tuebingen.mpg.de>
Tue, 8 Nov 2022 15:38:03 +0000 (16:38 +0100)
These lists are rather long and make the doxygen source code
documentation harder to read without providing a real benefit.

error.h
para.h

diff --git a/error.h b/error.h
index 82920ea8007e0d17d9de4b02ead6d402c9a334b4..f19aa634bf1f8a2306249a8898eacfefd0078a06 100644 (file)
--- a/error.h
+++ b/error.h
@@ -2,6 +2,7 @@
 
 /** \file error.h List of error codes and messages. */
 
+/** \cond para_error */
 /** Codes and messages. */
 #define PARA_ERRORS \
        PARA_ERROR(SUCCESS, "success"), \
@@ -261,6 +262,7 @@ enum para_error_codes {PARA_ERRORS};
 extern const char * const para_errlist[];
 /** Exactly one .c file per executable must define the array. */
 #define DEFINE_PARA_ERRLIST const char * const para_errlist[] = {PARA_ERRORS}
+/** \endcond para_error */
 
 /**
  * This bit indicates whether a number is considered a system error number
diff --git a/para.h b/para.h
index bbf91330855610ce0316986f2195d5161e3bc2bb..280c282323db369e7d0e84173324016aa425a92d 100644 (file)
--- a/para.h
+++ b/para.h
@@ -222,6 +222,7 @@ enum loglevels {LOGLEVELS, NUM_LOGLEVELS};
 #define PARA_CRIT_LOG(f,...) para_log(LL_CRIT, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
 #define PARA_EMERG_LOG(f,...) para_log(LL_EMERG, "%s: " f, __FUNCTION__, ## __VA_ARGS__)
 
+/** \cond status_items */
 #define STATUS_ITEMS \
        STATUS_ITEM(basename) \
        STATUS_ITEM(status) \
@@ -269,6 +270,7 @@ enum loglevels {LOGLEVELS, NUM_LOGLEVELS};
 enum status_items {STATUS_ITEMS NUM_STAT_ITEMS};
 #undef STATUS_ITEM
 #define STATUS_ITEM(_name) #_name,
+/** \endcond status items */
 
 extern const char *status_item_list[];
 /** Loop over each status item. */