Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Try harder to get make remote on VPATH (but doesn't work because dist creates the...
[simgrid.git] / src / modules.doc
index cc1c756..40f80ae 100644 (file)
@@ -8,10 +8,22 @@
 */
 /**    \defgroup XBT_ground Grounding features of the XBT (logging and error reporting)
        \ingroup XBT_API        */
-/**       \addtogroup  XBT_log
-          \ingroup XBT_ground  */
-/**       \addtogroup  XBT_error
-          \ingroup XBT_ground  */
+       /** \addtogroup  XBT_log
+           \ingroup XBT_ground  */
+          /** \defgroup XBT_log_cats Existing log categories
+              \ingroup XBT_log
+              \brief (automatically extracted) 
+              
+              This is the list of all existing log categories in SimGrid.
+               This list was automatically extracted from the source code by
+               the src/xbt_log_extract_hierarchy utility.
+              
+               You can thus be certain that it is uptodate, but it may somehow
+               lack a final manual touch.
+              Anyway, nothing's perfect ;)
+              */
+       /** \addtogroup  XBT_error
+           \ingroup XBT_ground  */
 
 /**    \defgroup XBT_structs  Datatypes defined in the XBT
        \ingroup XBT_API        */
          This a system call virtualization layer, which also acts as a
           portability layer.
          
+    \section GRAS_todo TODO
+     Documentation related:
+       - Add an example to the \ref GRAS_msg section, at least
+       - Document examples/gras/gras_stub_generator utility and how to deal
+         with the fact that programs must have a main in RL and not in SG.
+       - Document example/gras/ping as it uses almost all of the GRAS
+         features.
+     
+     Code related: too long to be written here. See the TODO file
+     
     @{
 */