Update copyright dates

[src/app-framework-binder.git] / include / afb / afb-verbosity.h

diff --git a/include/afb/afb-verbosity.h b/include/afb/afb-verbosity.h
index dd34f84..f31abfc 100644 (file)
--- a/include/afb/afb-verbosity.h
+++ b/include/afb/afb-verbosity.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2016, 2017, 2018 "IoT.bzh"
+ * Copyright (C) 2015-2020 "IoT.bzh"
  * Author: José Bollo <jose.bollo@iot.bzh>
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
@@ -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