From: mquinson Date: Thu, 10 Feb 2005 14:15:52 +0000 (+0000) Subject: Split GRAS doc into another file; add a gras example (still to be modified to look... X-Git-Tag: v3.3~4411 X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/commitdiff_plain/1b7854be6d046f7aff1209967630aea1075b0e01 Split GRAS doc into another file; add a gras example (still to be modified to look better) git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@940 48e7efb5-ca39-0410-a469-dd3cf9ba447f --- diff --git a/doc/Doxyfile.API.in b/doc/Doxyfile.API.in index e6a81d9f6f..b8a2e3fdfd 100644 --- a/doc/Doxyfile.API.in +++ b/doc/Doxyfile.API.in @@ -407,6 +407,7 @@ INPUT = @top_srcdir@/include/ \ @top_srcdir@/src/gras/Virtu \ @top_srcdir@/src/xbt/ \ @srcdir@/modules.doc \ + @srcdir@/module-gras.doc \ ./api_index.doc \ ./logcategories.doc @@ -446,7 +447,8 @@ EXCLUDE_PATTERNS = # directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = @top_srcdir@/src/surf/ @top_srcdir@/examples/msg/ +EXAMPLE_PATH = @top_srcdir@/src/surf/ @top_srcdir@/examples/msg/ \ + @top_srcdir@/examples/gras/ping # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp diff --git a/doc/module-gras.doc b/doc/module-gras.doc new file mode 100644 index 0000000000..db37f35443 --- /dev/null +++ b/doc/module-gras.doc @@ -0,0 +1,60 @@ +/** \addtogroup GRAS_API + + \section GRAS_funct Offered functionnalities + - Communication facilities: 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 + heterogeneity and convert them if needed. + - \ref GRAS_sock: this is how to open a communication channel to + other processes, and retrive information about them. + - \ref GRAS_msg: communications are message oriented. You have to + describe all possible messages and their payload beforehand, and + can then attach callbacks to the arrival of a given kind of message. + - Virtualization: Running both on top of the simulator and on + top of real platforms, and portability support. + - \ref GRAS_globals: The use of globals is forbidden since the + "processes" are threads in simulation mode. \n + This is how to let GRAS handle your globals properly. + - \ref GRAS_cond: How to declare specific code for the simulation mode + or for the real mode. + - \ref GRAS_virtu: You naturally don't want to call the + gettimeofday(2) function in simulation mode since it would give + you the time on the host running the simulation, not the time in + the simulated world (you are belonging to).\n + This a system call virtualization layer, which also acts as a + portability layer. + + \section GRAS_example Examples + + There is for now rather few examples of GRAS, but it's better than + nothing, isn't it? + + - \ref GRAS_ex_ping + + \section GRAS_todo TODO + Documentation related: + - Add an example to the \ref GRAS_msg section, at least + - Document examples/gras/gras_stub_generator utility and how to deal + with the fact that programs must have a main in RL and not in SG. + - Document example/gras/ping as it uses almost all of the GRAS + features. + + Code related: too long to be written here. See the TODO file + + @{ +*/ + + /** \defgroup GRAS_dd Data description */ + /** \defgroup GRAS_sock Sockets */ + /** \defgroup GRAS_msg Messages */ + + /** \defgroup GRAS_globals Globals */ + /** \defgroup GRAS_cond Conditional execution */ + /** \defgroup GRAS_virtu Syscalls */ + +/** @} */ + +/** \page GRAS_ex_ping The classical Ping-Pong in GRAS + \include gras/ping/ping.c + */ + diff --git a/doc/modules.doc b/doc/modules.doc index 40f80aee4b..f61d599c48 100644 --- a/doc/modules.doc +++ b/doc/modules.doc @@ -131,53 +131,7 @@ 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). - - \section GRAS_funct Offered functionnalities - - Communication facilities: 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 - heterogeneity and convert them if needed. - - \ref GRAS_sock: this is how to open a communication channel to - other processes, and retrive information about them. - - \ref GRAS_msg: communications are message oriented. You have to - describe all possible messages and their payload beforehand, and - can then attach callbacks to the arrival of a given kind of message. - - Virtualization: Running both on top of the simulator and on - top of real platforms, and portability support. - - \ref GRAS_globals: The use of globals is forbidden since the - "processes" are threads in simulation mode. \n - This is how to let GRAS handle your globals properly. - - \ref GRAS_cond: How to declare specific code for the simulation mode - or for the real mode. - - \ref GRAS_virtu: You naturally don't want to call the - gettimeofday(2) function in simulation mode since it would give - you the time on the host running the simulation, not the time in - the simulated world (you are belonging to).\n - This a system call virtualization layer, which also acts as a - portability layer. - - \section GRAS_todo TODO - Documentation related: - - Add an example to the \ref GRAS_msg section, at least - - Document examples/gras/gras_stub_generator utility and how to deal - with the fact that programs must have a main in RL and not in SG. - - Document example/gras/ping as it uses almost all of the GRAS - features. - - Code related: too long to be written here. See the TODO file - - @{ -*/ - - /** \defgroup GRAS_dd Data description */ - /** \defgroup GRAS_sock Sockets */ - /** \defgroup GRAS_msg Messages */ - - /** \defgroup GRAS_globals Globals */ - /** \defgroup GRAS_cond Conditional execution */ - /** \defgroup GRAS_virtu Syscalls */ - -/** @} */ +*/ /** \defgroup SMPI_API SMPI \ingroup SimGrid_API