Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Fix some documenttion bar
authornavarro <navarro@caraja.(none)>
Thu, 5 Apr 2012 12:08:33 +0000 (14:08 +0200)
committernavarro <navarro@caraja.(none)>
Thu, 5 Apr 2012 12:09:38 +0000 (14:09 +0200)
doc/gtut-howto-design.doc
doc/gtut-howto.doc
doc/gtut-introduction.doc
doc/gtut-main.doc
doc/gtut-tour.doc
doc/module-gras.doc

index f8614ef..c86158a 100644 (file)
@@ -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
index 153ec3a..175839e 100644 (file)
@@ -1,12 +1,6 @@
-/**
-@page GRAS_howto GRAS HOWTOs
-
-  \htmlonly <!--
-    DOXYGEN_NAVBAR_LABEL="HOWTOs"
-    DOXYGEN_NAVBAR_CHILD "Designing GRAS application"=GRAS_howto_design.html
-  --> \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:
index f53224e..7172091 100644 (file)
@@ -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
 
index 7bb9834..b41424e 100644 (file)
@@ -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 <!-- 
-      DOXYGEN_NAVBAR_LABEL="Tutorial"
-      DOXYGEN_NAVBAR_CHILD "What is GRAS"=GRAS_tut_intro.html
-      DOXYGEN_NAVBAR_CHILD "Initiatic tour"=GRAS_tut_tour.html
-      DOXYGEN_NAVBAR_CHILD "GRAS HOWTOs"=GRAS_howto.html
-    --> \endhtmlonly
-
 */
 
index 150509c..57b1320 100644 (file)
@@ -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)
index 86a249d..d3a7587 100644 (file)
@@ -1,22 +1,6 @@
-#####################################################################
-###########################  CORE ###################################
-#####################################################################
-
 /** \addtogroup GRAS_API
 
-\htmlonly
-<div class="toc">
-<div class="tocTitle">Table of content</div>
-<ol type="1">
-<li> <a href="#GRAS_funct">API documentation</a>
-<li> <a href="#GRAS_example">Examples</a>
-<li> <a href="#GRAS_tut_presentation">Tutorial</a>
-<li> <a href="#GRAS_howto_presentation">HOWTOs</a>
-</div>
-\endhtmlonly
-
-    \section GRAS_funct API documentation
-     GRAS offers the following functionnalities
+    \section GRAS_funct GRAS offers the following functionnalities
      - <b>\ref GRAS_comm</b>: 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
      most proeminent one is:
       
        - \ref GRAS_tut_tour_explicitwait_use
-       
-    \htmlonly <!-- 
-      DOXYGEN_NAVBAR_CHILD "Ping-Pong"=GRAS_ex_ping.html
-      DOXYGEN_NAVBAR_CHILD "RPC"=GRAS_ex_mmrpc.html
-      DOXYGEN_NAVBAR_CHILD "Token Ring"=GRAS_ex_token.html
-      DOXYGEN_NAVBAR_CHILD "Timers"=GRAS_ex_timer.html
-    --> \endhtmlonly
 
   There is some more examples in the distribution, under the directory
   <tt>examples/gras</tt>.
 #####################################################################
 #########################  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 
 --------------------- 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)
 -------------------------- 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 
 ---------------------------- 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.