New doc section: API of logs

[simgrid.git] / include / xbt / log.h

diff --git a/include/xbt/log.h b/include/xbt/log.h
index c5415c1..5ee5e4b 100644 (file)
--- a/include/xbt/log.h
+++ b/include/xbt/log.h
@@ -1,6 +1,6 @@
 /* log - a generic logging facility in the spirit of log4j                  */
 
-/* Copyright (c) 2004-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2004-2021. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -22,8 +22,8 @@
  * simulator.
  */
 
-/* XBT_LOG_MAYDAY: define this to replace the logging facilities with basic
-   printf function. Useful to debug the logging facilities themselves, or to not make source analysis tools mad */
+/* XBT_LOG_MAYDAY: define this to replace the logging facilities with basic printf function.
+   Useful to debug the logging facilities themselves, or to not make prehistoric source analysis tools mad. */
 //#define XBT_LOG_MAYDAY
 
 #ifndef XBT_LOG_H
@@ -46,7 +46,7 @@ typedef enum {
   xbt_log_priority_trace = 1,          /**< enter and return of some functions */
   xbt_log_priority_debug = 2,          /**< crufty output  */
   xbt_log_priority_verbose = 3,        /**< verbose output for the user wanting more */
-  xbt_log_priority_info = 4,           /**< output about the regular functionning */
+  xbt_log_priority_info = 4,           /**< output about the regular functioning */
   xbt_log_priority_warning = 5,        /**< minor issue encountered */
   xbt_log_priority_error = 6,          /**< issue encountered */
   xbt_log_priority_critical = 7,       /**< major issue encountered */
@@ -104,6 +104,7 @@ typedef enum {
 #define XBT_LOG_NEW_SUBCATEGORY_helper(catName, parent, desc)                                                          \
   SG_BEGIN_DECL                                                                                                        \
   extern void _XBT_LOGV_CTOR(catName)(void) XBT_ATTRIB_CONSTRUCTOR(600);                                               \
+  SG_END_DECL                                                                                                          \
   void _XBT_LOGV_CTOR(catName)(void)                                                                                   \
   {                                                                                                                    \
     XBT_LOG_EXTERNAL_CATEGORY(catName);                                                                                \
@@ -111,7 +112,6 @@ typedef enum {
       _xbt_log_cat_init(&_XBT_LOGV(catName), xbt_log_priority_uninitialized);                                          \
     }                                                                                                                  \
   }                                                                                                                    \
-  SG_END_DECL                                                                                                          \
   XBT_EXPORT_NO_IMPORT s_xbt_log_category_t _XBT_LOGV(catName) = {                                                     \
       &_XBT_LOGV(parent),                                                                                              \
       NULL /* firstChild */,                                                                                           \
@@ -493,4 +493,4 @@ extern xbt_log_layout_t xbt_log_default_layout;
 #define XBT_HELP(...) XBT_CINFO(xbt_help, __VA_ARGS__)
 
 SG_END_DECL
-#endif                          /* ! _XBT_LOG_H_ */
+#endif /* XBT_LOG_H */