doc/dev_guide/doxygen/simgrid.doc

   1 /*!
   2 \page simgrid SimGrid Developer Guide - SimGrid
   3
   4 We start to put TAGS in simgrid source code for having tutorials to see where is the important parts ans steps to create:
   5 \li a new MSG functions or a new API.
   6 \li a new model in surf.
   7 \li new tags in xml files
   8
   9 \section simgrid_dev_guide_api How to add a new MSG function?
  10
  11 Search for expression \"TUTORIAL: New API\".
  12 \verbatim
  13 user@caraja:~/workspace/simgrid/src$ cg "TUTORIAL: New API"
  14  0 msg/msg_new_api.c             15 /* TUTORIAL: New API*/
  15  1 simix/smx_smurf.c            582 /* TUTORIAL: New API*/
  16  2 simix/smx_smurf.c            616 /* TUTORIAL: New API*/
  17  3 simix/smx_smurf_private.h    102 /* TUTORIAL: New API*/
  18  4 simix/smx_smurf_private.h    629 /* TUTORIAL: New API*/
  19  5 simix/smx_private.h           28 /* TUTORIAL: New API*/
  20  6 simix/smx_private.h          101 /* TUTORIAL: New API*/
  21  7 simix/smx_private.h          182 /* TUTORIAL: New API*/
  22  8 simix/smx_global.c           454 /* TUTORIAL: New API*/
  23  9 simix/smx_new_api.c            8 /* TUTORIAL: New API*/
  24 10 simix/smx_user.c            1684 /* TUTORIAL: New API*/
  25 11 simix/smx_new_api_private.h    8 /* TUTORIAL: New API*/
  26 12 simix/smx_process.c          338 /* TUTORIAL: New API*/
  27 \endverbatim
  28
  29 \section simgrid_dev_guide_model How to add a new model in surf?
  30 Search for expression \"TUTORIAL: New model\".
  31 \verbatim
  32 user@caraja:~/workspace/simgrid/src$ cg "TUTORIAL: New model"
  33 0 surf/new_model_private.h   2 /* TUTORIAL: New model
  34 1 surf/surf.c              213 /* TUTORIAL: New model*/
  35 2 surf/surf_config.c       380 /* TUTORIAL: New model*/
  36 3 surf/surf_config.c       746 /* TUTORIAL: New model*/
  37 4 surf/new_model.c           8 /* TUTORIAL: New model*/
  38 5 include/surf/surf.h      157 /* TUTORIAL: New model*/
  39 6 include/surf/surf.h      345 /* TUTORIAL: New model*/
  40 7 include/surf/surf.h      661 /* TUTORIAL: New model*/
  41 \endverbatim
  42
  43 \section simgrid_dev_guide_tag What is How to add a new tag for xml files?
  44 Search for expression \"TUTORIAL: New TAG\".
  45 \verbatim
  46 user@caraja:~/workspace/simgrid/src$ cg "TUTORIAL: New TAG"
  47 0 surf/sg_platf.c                    43 /* TUTORIAL: New TAG*/
  48 1 surf/sg_platf.c                    89 /* TUTORIAL: New TAG*/
  49 2 surf/sg_platf.c                   124 /* TUTORIAL: New TAG*/
  50 3 surf/sg_platf.c                   337 /* TUTORIAL: New TAG*/
  51 4 surf/surfxml_parse.c              769 /* TUTORIAL: New TAG*/
  52 5 surf/surf_private.h               205 /* TUTORIAL: New TAG*/
  53 6 surf/surfxml_parseplatf.c          64 /* TUTORIAL: New TAG*/
  54 7 surf/surfxml_parseplatf.c          85 /* TUTORIAL: New TAG*/
  55 8 include/simgrid/platf_interface.h  42 /* TUTORIAL: New TAG*/
  56 \endverbatim
  57 */