add macros to the doc

clutchlog/clutchlog.h

@@ -2,6 +2,8 @@
 #define __CLUTCHLOG_H__
 #pragma once
 
+/** @file */
+
 #include <filesystem>
 #include <iostream>
 #include <sstream>
@@ -36,6 +38,9 @@
  **********************************************************************/
 #ifdef WITH_CLUTCHLOG
 
+/** @addtogroup DefaultConfigMacros Default configuration macros
+ * @{ **/
+
 #ifndef CLUTCHLOG_DEFAULT_FORMAT
 //! Default format of the messages.
 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
@@ -67,6 +72,11 @@
 #define CLUTCHLOG_DEFAULT_DEPTH_BUILT_NODEBUG clutchlog::level::progress
 #endif // CLUTCHLOG_DEFAULT_DEPTH_BUILT
 
+/** @} */
+
+/** @addtogroup UseMacros High-level API macros
+ * @{ */
+
 //! Handy shortcuts to location.
 #define CLUTCHLOC __FILE__, __FUNCTION__, __LINE__
 
@@ -104,6 +114,8 @@
 }
 #endif // NDEBUG
 
+/** @} */
+
 #else // not WITH_CLUTCHLOG
 // Disabled macros can still be used in Release builds.
 #define CLUTCHLOG( LEVEL, WHAT ) { do {/*nothing*/} while(false); }
@@ -115,9 +127,12 @@
  **********************************************************************/
 
 #ifdef WITH_CLUTCHLOG
-/** Single class that holds everything.
+/** The single class which holds everything.
  *
  * This is a Singleton class.
+ *
+ * @addtogroup Main Main class
+ * @{
  */
 class clutchlog
 {
@@ -142,6 +157,9 @@ class clutchlog
 
         /** @} */
 
+        /** @addtogroup Formating Formating tools
+         * @{ */
+
         /** @name Formating API
          * @{ */
 
@@ -258,6 +276,7 @@ class clutchlog
         }; // fmt class
 
         /** @} */
+        /** @} */
 
     /** @name Internal details
      * @{ */
@@ -682,6 +701,8 @@ class clutchlog
         /** @} */
 };
 
+/** @} */
+
 #else // not WITH_CLUTCHLOG