doc/gtut-main.doc

   1 /**
   2 @addtogroup GRAS_tut
   3
   4 This section constitutes a tutorial to the GRAS programming environment.
   5
   6  - \ref GRAS_tut_intro :\n
   7    This section details what GRAS is, and what are the target application
   8    class. It also formalize somehow the communication model used in GRAS.\n
   9    If you are new to the system and want to start using the tool as quickly
  10    as possible and learn by trying things out instead of reading a lenghty
  11    manual, you might want to start from next section directly.
  12    - \ref GRAS_tut_intro_what
  13    - \ref GRAS_tut_intro_model
  14
  15  - \ref GRAS_tut_tour :\n
  16    This section aims at turning new-comers into GRAS power user. It briefly
  17    explains how to install the framework and setup your own projects. Then,
  18    an example distributed application is builded incrementaly to show the
  19    several aspects of the framework.
  20    - Part 1: Bases
  21      - \ref GRAS_tut_tour_install
  22      - \ref GRAS_tut_tour_setup
  23    - Part 2: Message passing
  24      - \ref GRAS_tut_tour_simpleexchange
  25      - \ref GRAS_tut_tour_args
  26      - \ref GRAS_tut_tour_callbacks
  27      - \ref GRAS_tut_tour_globals
  28      - \ref GRAS_tut_tour_logs
  29      - \ref GRAS_tut_tour_timers
  30      - \ref GRAS_tut_tour_exceptions
  31      - \ref GRAS_tut_tour_simpledata
  32      - \ref GRAS_tut_tour_rpc
  33      - \ref GRAS_tut_tour_explicitwait
  34      - \ref GRAS_tut_tour_message_recaping
  35    - Part 3: Data description
  36      - \ref GRAS_tut_tour_staticstruct
  37      - \ref GRAS_tut_tour_pointers
  38      - \ref GRAS_tut_tour_dynar
  39      - \ref GRAS_tut_tour_manualdatadef
  40      - \ref GRAS_tut_tour_exchangecb
  41    - Part 4: Advanced topics (TODO)
  42
  43  - \ref GRAS_howto :\n
  44    This section contains some self-contained document explaining one
  45    aspect of the framework which would be hard to integrate in the
  46    suite of lessons composing the tutorial.
  47     - \ref GRAS_howto_design
  48
  49     \htmlonly <!--
  50       DOXYGEN_NAVBAR_LABEL="Tutorial"
  51       DOXYGEN_NAVBAR_CHILD "What is GRAS"=GRAS_tut_intro.html
  52       DOXYGEN_NAVBAR_CHILD "Initiatic tour"=GRAS_tut_tour.html
  53       DOXYGEN_NAVBAR_CHILD "GRAS HOWTOs"=GRAS_howto.html
  54     --> \endhtmlonly
  55
  56 */
  57