From 22faac786c18ab3759fd30f85c957721708388d1 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Mon, 3 Oct 2022 00:33:59 +0200 Subject: [PATCH] Exclude status items and error list from doxygen. These lists are rather long and make the doxygen source code documentation harder to read without providing a real benefit. --- error.h | 2 ++ para.h | 2 ++ 2 files changed, 4 insertions(+) diff --git a/error.h b/error.h index 82920ea8..f19aa634 100644 --- 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 bbf91330..280c2823 100644 --- 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. */ -- 2.39.2