Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
remove some cruft from doxygen
authorMartin Quinson <martin.quinson@loria.fr>
Sat, 21 May 2016 04:36:48 +0000 (06:36 +0200)
committerMartin Quinson <martin.quinson@loria.fr>
Sat, 21 May 2016 04:36:48 +0000 (06:36 +0200)
doc/Doxyfile.in
doc/Layout.xml
doc/doxygen/module-index.doc [moved from doc/doxygen/modules.doc with 100% similarity]
doc/doxygen/module-msg.doc
doc/doxygen/module-xbt.doc
doc/doxygen/options.doc
doc/doxygen/platform.doc
include/xbt/file.h
tools/cmake/DefinePackages.cmake

index b795ddc..e33acbe 100644 (file)
@@ -664,9 +664,9 @@ INPUT                  = doxygen/index.doc \
                           doxygen/contributing.doc \
                          doxygen/tracing.doc \
                         doxygen/FAQ.doc \
                           doxygen/contributing.doc \
                          doxygen/tracing.doc \
                         doxygen/FAQ.doc \
-                        doxygen/modules.doc \
+                        doxygen/module-msg.doc \
+                        doxygen/module-index.doc \
                            doxygen/module-xbt.doc \
                            doxygen/module-xbt.doc \
-                           doxygen/module-msg.doc \
                            doxygen/module-sd.doc \
                            doxygen/module-surf.doc \
                            doxygen/module-simix.doc \
                            doxygen/module-sd.doc \
                            doxygen/module-surf.doc \
                            doxygen/module-simix.doc \
index 29d52d6..6ed5725 100644 (file)
@@ -4,27 +4,14 @@
 
     <tab type="mainpage" visible="yes" title="SimGrid User Documentation" />
 
 
     <tab type="mainpage" visible="yes" title="SimGrid User Documentation" />
 
-    <tab type="usergroup" visible="yes" title="Reference documentation" intro="Reference documentation">
-      <tab type="namespaces" visible="no" title="">
-        <tab type="namespaces" visible="yes" title="" intro=""/>
-      </tab>
-      <tab type="examples" visible="yes" title="" intro=""/>  
-      <tab type="classes" visible="no" title="">
-        <tab type="classes" visible="yes" title="" intro=""/>
-        <tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/> 
-        <tab type="hierarchy" visible="yes" title="" intro=""/>
-        <tab type="classmembers" visible="no" title="" intro=""/>
-      </tab>
-      <tab type="modules" visible="no" title="" intro="">
-        <tab type="modules" visible="yes" title="APIs Reference"
+    <tab type="modules" visible="yes" title="APIs Reference"
              intro="Here is the hierarchical view of all SimGrid modules. You can reduce the amount of detail with the 'detail level' setting, on the right."/>
              intro="Here is the hierarchical view of all SimGrid modules. You can reduce the amount of detail with the 'detail level' setting, on the right."/>
-      </tab>
-    </tab>
   </navindex>
 
   <!-- Layout definition for a class page -->
   <class>
     <briefdescription visible="yes"/>
   </navindex>
 
   <!-- Layout definition for a class page -->
   <class>
     <briefdescription visible="yes"/>
+    <detaileddescription title=""/>
     <includes visible="$SHOW_INCLUDE_FILES"/>
     <inheritancegraph visible="$CLASS_GRAPH"/>
     <collaborationgraph visible="$COLLABORATION_GRAPH"/>
     <includes visible="$SHOW_INCLUDE_FILES"/>
     <inheritancegraph visible="$CLASS_GRAPH"/>
     <collaborationgraph visible="$COLLABORATION_GRAPH"/>
@@ -61,7 +48,6 @@
       <related title="" subtitle=""/>
       <membergroups visible="yes"/>
     </memberdecl>
       <related title="" subtitle=""/>
       <membergroups visible="yes"/>
     </memberdecl>
-    <detaileddescription title=""/>
     <memberdef>
       <typedefs title=""/>
       <enums title=""/>
     <memberdef>
       <typedefs title=""/>
       <enums title=""/>
similarity index 100%
rename from doc/doxygen/modules.doc
rename to doc/doxygen/module-index.doc
index 4b48cc4..f02e254 100644 (file)
@@ -1,3 +1,31 @@
+/** \defgroup SD_API      SimDag
+    \brief Programming environment for DAG applications
+
+    SimDag provides some functionnalities to simulate parallel task scheduling
+    with DAGs models (Direct Acyclic Graphs).
+    The old versions of SimGrid were based on DAGs. But the DAG part (named SG)
+    was removed in SimGrid 3 because the new kernel (\ref SURF_API) was implemented. \ref SURF_API
+    was much faster and more flexible than SG and did not use DAGs.
+    SimDag is a new implementation of DAGs handling and it is built on top of \ref SURF_API.
+
+    \section SD_who Who should use this (and who shouldn't)
+
+    You should use this programming environment of the SimGrid suite if you want
+    to study algorithms and heuristics with DAGs of parallel tasks.
+    If you don't need to use DAGs for your simulation, have a look at the
+    \ref MSG_API programming environment.
+    If you want to study an existing MPI program, have a look at the
+    \ref SMPI_API one.
+    If none of those programming environments fits your needs, you may
+    consider implementing your own directly on top of \ref SURF_API (but you
+    probably want to contact us before).
+*/
+
+/** \defgroup SMPI_API      SMPI
+    \brief Programming environment for the simulation of MPI applications
+*/
+
+
 /**
 @defgroup XBT_API      XBT
 @brief The core toolbox of SimGrid, containing usefull datatypes and friends
 /**
 @defgroup XBT_API      XBT
 @brief The core toolbox of SimGrid, containing usefull datatypes and friends
@@ -31,34 +59,6 @@ parameter in the command line (see \ref tracing for details).
 */
 
 
 */
 
 
-/** \defgroup SMPI_API      SMPI
-    \brief Programming environment for the simulation of MPI applications
-*/
-
-
-/** \defgroup SD_API      SimDag
-    \brief Programming environment for DAG applications
-
-    SimDag provides some functionnalities to simulate parallel task scheduling
-    with DAGs models (Direct Acyclic Graphs).
-    The old versions of SimGrid were based on DAGs. But the DAG part (named SG)
-    was removed in SimGrid 3 because the new kernel (\ref SURF_API) was implemented. \ref SURF_API
-    was much faster and more flexible than SG and did not use DAGs.
-    SimDag is a new implementation of DAGs handling and it is built on top of \ref SURF_API.
-
-    \section SD_who Who should use this (and who shouldn't)
-
-    You should use this programming environment of the SimGrid suite if you want
-    to study algorithms and heuristics with DAGs of parallel tasks.
-    If you don't need to use DAGs for your simulation, have a look at the
-    \ref MSG_API programming environment.
-    If you want to study an existing MPI program, have a look at the
-    \ref SMPI_API one.
-    If none of those programming environments fits your needs, you may
-    consider implementing your own directly on top of \ref SURF_API (but you
-    probably want to contact us before).
-
-*/
 
 /**
 @defgroup SURF_API SURF
 
 /**
 @defgroup SURF_API SURF
index b63e181..1636eb9 100644 (file)
@@ -1,5 +1,5 @@
 /**
 /**
-@page MSG_API  MSG: Simple API for CSP Algorithms
+@defgroup MSG_API  MSG: Simple API for CSP Algorithms
 @brief Simple programming environment
 
 MSG is a simple API to write algorithms organized with Concurrent
 @brief Simple programming environment
 
 MSG is a simple API to write algorithms organized with Concurrent
index 686f202..30df372 100644 (file)
@@ -18,7 +18,6 @@
       - \ref XBT_set
         Data are associated to both an ID (0(1) search) and a name
       - \ref XBT_fifo
       - \ref XBT_set
         Data are associated to both an ID (0(1) search) and a name
       - \ref XBT_fifo
-      - \ref XBT_queue
       - \ref XBT_swag
       - \ref XBT_heap
       - \ref XBT_peer
       - \ref XBT_swag
       - \ref XBT_heap
       - \ref XBT_peer
@@ -84,8 +83,6 @@
      /** @defgroup XBT_graph General purpose graph library */
      /** @defgroup XBT_parmap Parallel map */    
      /** @defgroup XBT_peer Peer */    
      /** @defgroup XBT_graph General purpose graph library */
      /** @defgroup XBT_parmap Parallel map */    
      /** @defgroup XBT_peer Peer */    
-     /** @defgroup XBT_queue Queue */
-     /** @defgroup XBT_sock Sock */    
      /** @defgroup XBT_synchro Synchro stuff */        
      /** @defgroup XBT_thread Thread stuff */  
      /** @defgroup XBT_context Portable context implementation */              
      /** @defgroup XBT_synchro Synchro stuff */        
      /** @defgroup XBT_thread Thread stuff */  
      /** @defgroup XBT_context Portable context implementation */              
index f25de99..27e205d 100644 (file)
@@ -782,7 +782,7 @@ larger than 1 and a slow-down if it is smaller than 1. Nothing will be changed i
 equal to 1.
 
 Of course, you can set any arbitrary filenames you want (so the start and end don't have to be
 equal to 1.
 
 Of course, you can set any arbitrary filenames you want (so the start and end don't have to be
-in the same file), but be aware that this mechanism only supports \i consecutive calls!
+in the same file), but be aware that this mechanism only supports @em consecutive calls!
 
 \note
     Please note that you must pass the \b -trace-call-location flag to smpicc
 
 \note
     Please note that you must pass the \b -trace-call-location flag to smpicc
index 963f3cc..35fe5a0 100644 (file)
@@ -695,7 +695,7 @@ id              | yes       | string | Name of the link that is supposed to act
   This section describes the storage management under SimGrid ; nowadays
   it's only usable with MSG. It relies basically on linux-like concepts.
   You also may want to have a look to its corresponding section in 
   This section describes the storage management under SimGrid ; nowadays
   it's only usable with MSG. It relies basically on linux-like concepts.
   You also may want to have a look to its corresponding section in 
-  @ref msg-file-page ; access functions are organized as a POSIX-like
+  @ref msg_file ; access functions are organized as a POSIX-like
   interface.
 
 \subsubsection pf_sto_conc Storage - Main Concepts
   interface.
 
 \subsubsection pf_sto_conc Storage - Main Concepts
index 1af89b7..a907eaa 100644 (file)
@@ -18,8 +18,8 @@
 
 SG_BEGIN_DECL()
 
 
 SG_BEGIN_DECL()
 
-/** @addtogroup XBT_file
- *  @brief File manipulation functions
+/** @defgroup XBT_file File manipulation functions
+ *  @ingroup XBT
  *
  * This module redefine some quite classical functions such as xbt_getline() or xbt_dirname() for the platforms
  * lacking them.
  *
  * This module redefine some quite classical functions such as xbt_getline() or xbt_dirname() for the platforms
  * lacking them.
index 8225800..1fb2900 100644 (file)
@@ -811,7 +811,7 @@ set(DOC_SOURCES
   doc/doxygen/module-surf.doc
   doc/doxygen/module-trace.doc
   doc/doxygen/module-xbt.doc
   doc/doxygen/module-surf.doc
   doc/doxygen/module-trace.doc
   doc/doxygen/module-xbt.doc
-  doc/doxygen/modules.doc
+  doc/doxygen/module-index.doc
   doc/doxygen/options.doc
   doc/doxygen/platform.doc
   doc/doxygen/pls.doc
   doc/doxygen/options.doc
   doc/doxygen/platform.doc
   doc/doxygen/pls.doc