diff options
| author |   José Bollo <jose.bollo@iot.bzh> | 2018-06-19 20:16:28 +0200 |
|---|---|---|
| committer | José Bollo <jose.bollo@iot.bzh> | 2018-06-22 09:48:48 +0200 |
| commit | 525e9eaa644ca92fad23adfbb7c3119ae8b57a30 (patch) | |
| tree | 41de59627ccc937450daf4da6488efd4f4b2f3c2 /include/afb/afb-verbosity.h | |
| parent | 9e15212d26916f59fae2be6d9e618ae9b75a4f40 (diff) | |
Improve documentation of api v3
The documentation is improved to reflect the new version.
Tune the options
Change-Id: I894c3db3bc0c10e89db66a9a51a9ad049bb8c0c4
Signed-off-by: José Bollo <jose.bollo@iot.bzh>
Diffstat (limited to 'include/afb/afb-verbosity.h')
| -rw-r--r-- | include/afb/afb-verbosity.h | 36 |
1 files changed, 25 insertions, 11 deletions
diff --git a/include/afb/afb-verbosity.h b/include/afb/afb-verbosity.h index dd34f841..288205bd 100644 --- a/include/afb/afb-verbosity.h +++ b/include/afb/afb-verbosity.h @@ -17,11 +17,14 @@ #pragma once -#define AFB_VERBOSITY_LEVEL_ERROR 0 -#define AFB_VERBOSITY_LEVEL_WARNING 1 -#define AFB_VERBOSITY_LEVEL_NOTICE 2 -#define AFB_VERBOSITY_LEVEL_INFO 3 -#define AFB_VERBOSITY_LEVEL_DEBUG 4 +/** @defgroup AFB_LOGGING + * @{ */ + +#define AFB_VERBOSITY_LEVEL_ERROR 0 /**< @deprecated in favor of @ref AFB_SYSLOG_LEVEL_ERROR */ +#define AFB_VERBOSITY_LEVEL_WARNING 1 /**< @deprecated in favor of @ref AFB_SYSLOG_LEVEL_WARNING */ +#define AFB_VERBOSITY_LEVEL_NOTICE 2 /**< @deprecated in favor of @ref AFB_SYSLOG_LEVEL_NOTICE */ +#define AFB_VERBOSITY_LEVEL_INFO 3 /**< @deprecated in favor of @ref AFB_SYSLOG_LEVEL_INFO */ +#define AFB_VERBOSITY_LEVEL_DEBUG 4 /**< @deprecated in favor of @ref AFB_SYSLOG_LEVEL_DEBUG */ #define AFB_SYSLOG_LEVEL_EMERGENCY 0 #define AFB_SYSLOG_LEVEL_ALERT 1 @@ -32,13 +35,13 @@ #define AFB_SYSLOG_LEVEL_INFO 6 #define AFB_SYSLOG_LEVEL_DEBUG 7 -#define AFB_VERBOSITY_LEVEL_WANT(verbosity,level) ((verbosity) >= (level)) +#define AFB_VERBOSITY_LEVEL_WANT(verbosity,level) ((verbosity) >= (level)) /**< @deprecated in favor of @ref AFB_SYSLOG_MASK_WANT */ -#define AFB_VERBOSITY_LEVEL_WANT_ERROR(x) AFB_VERBOSITY_LEVEL_WANT(x,AFB_VERBOSITY_LEVEL_ERROR) -#define AFB_VERBOSITY_LEVEL_WANT_WARNING(x) AFB_VERBOSITY_LEVEL_WANT(x,AFB_VERBOSITY_LEVEL_WARNING) -#define AFB_VERBOSITY_LEVEL_WANT_NOTICE(x) AFB_VERBOSITY_LEVEL_WANT(x,AFB_VERBOSITY_LEVEL_NOTICE) -#define AFB_VERBOSITY_LEVEL_WANT_INFO(x) AFB_VERBOSITY_LEVEL_WANT(x,AFB_VERBOSITY_LEVEL_INFO) -#define AFB_VERBOSITY_LEVEL_WANT_DEBUG(x) AFB_VERBOSITY_LEVEL_WANT(x,AFB_VERBOSITY_LEVEL_DEBUG) +#define AFB_VERBOSITY_LEVEL_WANT_ERROR(x) AFB_VERBOSITY_LEVEL_WANT(x,AFB_VERBOSITY_LEVEL_ERROR) /**< @deprecated in favor of @ref AFB_SYSLOG_MASK_WANT_ERROR */ +#define AFB_VERBOSITY_LEVEL_WANT_WARNING(x) AFB_VERBOSITY_LEVEL_WANT(x,AFB_VERBOSITY_LEVEL_WARNING) /**< @deprecated in favor of @ref AFB_SYSLOG_MASK_WANT_WARNING */ +#define AFB_VERBOSITY_LEVEL_WANT_NOTICE(x) AFB_VERBOSITY_LEVEL_WANT(x,AFB_VERBOSITY_LEVEL_NOTICE) /**< @deprecated in favor of @ref AFB_SYSLOG_MASK_WANT_NOTICE */ +#define AFB_VERBOSITY_LEVEL_WANT_INFO(x) AFB_VERBOSITY_LEVEL_WANT(x,AFB_VERBOSITY_LEVEL_INFO) /**< @deprecated in favor of @ref AFB_SYSLOG_MASK_WANT_INFO */ +#define AFB_VERBOSITY_LEVEL_WANT_DEBUG(x) AFB_VERBOSITY_LEVEL_WANT(x,AFB_VERBOSITY_LEVEL_DEBUG) /**< @deprecated in favor of @ref AFB_SYSLOG_MASK_WANT_DEBUG */ #define AFB_SYSLOG_MASK_WANT(verbomask,level) ((verbomask) & (1 << (level))) @@ -54,6 +57,16 @@ #define AFB_SYSLOG_LEVEL_FROM_VERBOSITY(x) ((x) + (AFB_SYSLOG_LEVEL_ERROR - AFB_VERBOSITY_LEVEL_ERROR)) #define AFB_SYSLOG_LEVEL_TO_VERBOSITY(x) ((x) + (AFB_VERBOSITY_LEVEL_ERROR - AFB_SYSLOG_LEVEL_ERROR)) +/** + * Transform a mask of verbosity to its significant level of verbosity. + * + * @param verbomask the mask + * + * @return the upper level that is not null, truncated to AFB_SYSLOG_LEVEL_DEBUG + * + * @example _afb_verbomask_to_upper_level_(5) -> 2 + * @example _afb_verbomask_to_upper_level_(16) -> 4 + */ static inline int _afb_verbomask_to_upper_level_(int verbomask) { int result = 0; @@ -62,3 +75,4 @@ static inline int _afb_verbomask_to_upper_level_(int verbomask) return result; } +/** @} */
\ No newline at end of file |