From: Martin Quinson Date: Sat, 21 May 2016 04:36:48 +0000 (+0200) Subject: remove some cruft from doxygen X-Git-Tag: v3_14~1197 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/1ad19bb40f7e74d3fb3689982c36794866c645e3 remove some cruft from doxygen --- diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index b795ddce21..e33acbee36 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -664,9 +664,9 @@ INPUT = doxygen/index.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-msg.doc \ doxygen/module-sd.doc \ doxygen/module-surf.doc \ doxygen/module-simix.doc \ diff --git a/doc/Layout.xml b/doc/Layout.xml index 29d52d6827..6ed5725b3b 100644 --- a/doc/Layout.xml +++ b/doc/Layout.xml @@ -4,27 +4,14 @@ - - - - - - - - - - - - - - - + @@ -61,7 +48,6 @@ - diff --git a/doc/doxygen/modules.doc b/doc/doxygen/module-index.doc similarity index 100% rename from doc/doxygen/modules.doc rename to doc/doxygen/module-index.doc index 4b48cc44b2..f02e254a45 100644 --- a/doc/doxygen/modules.doc +++ b/doc/doxygen/module-index.doc @@ -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 @@ -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 diff --git a/doc/doxygen/module-msg.doc b/doc/doxygen/module-msg.doc index b63e181495..1636eb9324 100644 --- a/doc/doxygen/module-msg.doc +++ b/doc/doxygen/module-msg.doc @@ -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 diff --git a/doc/doxygen/module-xbt.doc b/doc/doxygen/module-xbt.doc index 686f202645..30df3723e7 100644 --- a/doc/doxygen/module-xbt.doc +++ b/doc/doxygen/module-xbt.doc @@ -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_queue - \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_queue Queue */ - /** @defgroup XBT_sock Sock */ /** @defgroup XBT_synchro Synchro stuff */ /** @defgroup XBT_thread Thread stuff */ /** @defgroup XBT_context Portable context implementation */ diff --git a/doc/doxygen/options.doc b/doc/doxygen/options.doc index f25de99a46..27e205df85 100644 --- a/doc/doxygen/options.doc +++ b/doc/doxygen/options.doc @@ -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 -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 diff --git a/doc/doxygen/platform.doc b/doc/doxygen/platform.doc index 963f3cc73a..35fe5a0c50 100644 --- a/doc/doxygen/platform.doc +++ b/doc/doxygen/platform.doc @@ -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 - @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 diff --git a/include/xbt/file.h b/include/xbt/file.h index 1af89b7711..a907eaad60 100644 --- a/include/xbt/file.h +++ b/include/xbt/file.h @@ -18,8 +18,8 @@ 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. diff --git a/tools/cmake/DefinePackages.cmake b/tools/cmake/DefinePackages.cmake index 8225800543..1fb2900bd7 100644 --- a/tools/cmake/DefinePackages.cmake +++ b/tools/cmake/DefinePackages.cmake @@ -811,7 +811,7 @@ set(DOC_SOURCES 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