From: navarro Date: Thu, 5 Apr 2012 12:08:33 +0000 (+0200) Subject: Fix some documenttion bar X-Git-Tag: v3_7~81 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/57f66e7bcc0dc484668124842e595ffd5a657b6f Fix some documenttion bar --- diff --git a/doc/gtut-howto-design.doc b/doc/gtut-howto-design.doc index f8614efb70..c86158a052 100644 --- a/doc/gtut-howto-design.doc +++ b/doc/gtut-howto-design.doc @@ -1,4 +1,5 @@ -/** @page GRAS_howto_design HOWTO design a GRAS application +/** @defgroup GRAS_howto_design HOWTO design a GRAS application + @ingroup GRAS_howto HOWTOs This page tries to give some hints on how to design a GRAS application. The provided model and functionnalities are somehow different from the other diff --git a/doc/gtut-howto.doc b/doc/gtut-howto.doc index 153ec3a7b8..175839e021 100644 --- a/doc/gtut-howto.doc +++ b/doc/gtut-howto.doc @@ -1,12 +1,6 @@ -/** -@page GRAS_howto GRAS HOWTOs - - \htmlonly \endhtmlonly +/** @defgroup GRAS_howto HOWTOs + @ingroup GRAS_tut - This page tries to explain how to use the GRAS framework. It does not focus on specific functionalities (which are detailed in the initiatic tour), but rather on global aspects. Here is the list of existing howtos for now: diff --git a/doc/gtut-introduction.doc b/doc/gtut-introduction.doc index f53224e523..71720918a6 100644 --- a/doc/gtut-introduction.doc +++ b/doc/gtut-introduction.doc @@ -1,5 +1,5 @@ -/** -@page GRAS_tut_intro Introduction to the GRAS framework +/** @defgroup GRAS_tut_intro What is GRAS + @ingroup GRAS_tut \htmlinclude .gtut-introduction.doc.toc diff --git a/doc/gtut-main.doc b/doc/gtut-main.doc index 7bb98342e0..b41424e080 100644 --- a/doc/gtut-main.doc +++ b/doc/gtut-main.doc @@ -46,12 +46,5 @@ This section constitutes a tutorial to the GRAS programming environment. suite of lessons composing the tutorial. - \ref GRAS_howto_design - \htmlonly \endhtmlonly - */ diff --git a/doc/gtut-tour.doc b/doc/gtut-tour.doc index 150509ce4a..57b1320174 100644 --- a/doc/gtut-tour.doc +++ b/doc/gtut-tour.doc @@ -1,6 +1,5 @@ - -/** -@page GRAS_tut_tour GRAS initiatic tour +/** @defgroup GRAS_tut_tour Initiatic tour + @ingroup GRAS_tut During this tour, you will learn all you need to write your own GRAS applications, from the installation of the framework to the use of (almost) diff --git a/doc/module-gras.doc b/doc/module-gras.doc index 86a249d7cd..d3a7587440 100644 --- a/doc/module-gras.doc +++ b/doc/module-gras.doc @@ -1,22 +1,6 @@ -##################################################################### -########################### CORE ################################### -##################################################################### - /** \addtogroup GRAS_API -\htmlonly -
-
Table of content
-
    -
  1. API documentation -
  2. Examples -
  3. Tutorial -
  4. HOWTOs -
-\endhtmlonly - - \section GRAS_funct API documentation - GRAS offers the following functionnalities + \section GRAS_funct GRAS offers the following functionnalities - \ref GRAS_comm: Exchanging messages between peers - \ref GRAS_dd : any data which may transit on the network must be described beforehand so that GRAS can handle the platform @@ -44,8 +28,8 @@ execution time into the simulator and having code sections specific to simulation or to real mode). - \section GRAS_example Examples - + \section GRAS_examples Examples + There is for now rather few examples of GRAS, but it's better than nothing, isn't it? @@ -58,7 +42,7 @@ most proeminent one is: - \ref GRAS_tut_tour_explicitwait_use - + \section GRAS_tut_presentation Tutorial We even have a tutorial for the GRAS framework. It details in a @@ -84,7 +68,7 @@ - \ref GRAS_tut_tour_explicitwait - \ref GRAS_tut_tour_message_recaping - \section GRAS_howto_presentation HOWTOs + \section GRAS_howto_presentation HOWTOsbis The tutorial and the API documentation present the framework little piece by little piece and provide a lot of information on each of them. @@ -99,7 +83,7 @@ /** @defgroup GRAS_comm Communication facilities */ /** @defgroup GRAS_run Virtualization */ /** @defgroup GRAS_ex Examples */ - /** @defgroup GRAS_tut GRAS Tutorial */ + /** @defgroup GRAS_tut Tutorial */ /** @} */ ##################################################################### /** @addtogroup GRAS_comm @@ -150,13 +134,6 @@ most proeminent one is: - \ref GRAS_tut_tour_explicitwait_use - - \htmlonly \endhtmlonly There is some more examples in the distribution, under the directory examples/gras. @@ -165,12 +142,11 @@ ##################################################################### ######################### EXAMPLES ################################# ##################################################################### - --------------------------------------------------------------------- ------------------------- Ping Pong --------------------------------- --------------------------------------------------------------------- - -/** \page GRAS_ex_ping The classical Ping-Pong in GRAS +/** @defgroup GRAS_ex_ping Ping-Pong + @ingroup GRAS_ex This example implements the very classical ping-pong in GRAS. It involves a client (initiating the ping-pong) and a server (answering to @@ -284,7 +260,8 @@ --------------------- Simple Token Ring ----------------------------- --------------------------------------------------------------------- -/** \page GRAS_ex_token Token Ring example +/** @defgroup GRAS_ex_token Token Ring example + @ingroup GRAS_ex This example implements the token ring algorithm. It involves several nodes arranged in a ring (each of them have a left and a right neighbour) @@ -351,7 +328,8 @@ -------------------------- MM RPC ----------------------------------- --------------------------------------------------------------------- -/** \page GRAS_ex_mmrpc A simple RPC for matrix multiplication +/** @defgroup GRAS_ex_mmrpc A simple RPC for matrix multiplication + @ingroup GRAS_ex This example implements a remote matrix multiplication. It involves a client (creating the matrices and sending the multiplications requests) and a server @@ -498,7 +476,8 @@ ---------------------------- Timers --------------------------------- --------------------------------------------------------------------- -/** \page GRAS_ex_timer Some timer games +/** @defgroup GRAS_ex_timer Some timer games + @ingroup GRAS_ex This example fools around with the GRAS timers (\ref GRAS_timer). It is mainly a regression test, since it uses almost all timer features.