Documentation fixups: some arguments got renamed, and the DTD did also

[simgrid.git] / src / msg / environment.c

diff --git a/src/msg/environment.c b/src/msg/environment.c
index c4988a8..066ca48 100644 (file)
--- a/src/msg/environment.c
+++ b/src/msg/environment.c
@@ -1,12 +1,12 @@
 /*     $Id$      */
 /*     $Id$      */

-  
+

 /* Copyright (c) 2002-2007 Arnaud Legrand.                                  */
 /* Copyright (c) 2007 Bruno Donassolo.                                      */
 /* All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 /* Copyright (c) 2002-2007 Arnaud Legrand.                                  */
 /* Copyright (c) 2007 Bruno Donassolo.                                      */
 /* All rights reserved.                                                     */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */

-  
+

 #include "msg/private.h"
 #include "xbt/sysdep.h"
 #include "xbt/log.h"
 #include "msg/private.h"
 #include "xbt/sysdep.h"
 #include "xbt/log.h"


@@ -15,6 +15,8 @@
  *  \brief This section describes functions to manage the platform creation
  *  and the application deployment. You should also have a look at 
  *  \ref MSG_examples  to have an overview of their usage.
  *  \brief This section describes functions to manage the platform creation
  *  and the application deployment. You should also have a look at 
  *  \ref MSG_examples  to have an overview of their usage.

+ */
+/** @addtogroup msg_easier_life

  *    \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Platforms and Applications" --> \endhtmlonly
  * 
  */
  *    \htmlonly <!-- DOXYGEN_NAVBAR_LABEL="Platforms and Applications" --> \endhtmlonly
  * 
  */


@@ -30,13 +32,13 @@
  */
 m_host_t MSG_get_host_by_name(const char *name)
 {
  */
 m_host_t MSG_get_host_by_name(const char *name)
 {

-       smx_host_t simix_h = NULL;
+  smx_host_t simix_h = NULL;

 
 

-       simix_h = SIMIX_host_get_by_name(name);
-       if (simix_h == NULL) {
-               return NULL;
-       }
-       else return (m_host_t)simix_h->data;
+  simix_h = SIMIX_host_get_by_name(name);
+  if (simix_h == NULL) {
+    return NULL;
+  } else
+    return (m_host_t) simix_h->data;

 }
 
 /** \ingroup msg_easier_life
 }
 
 /** \ingroup msg_easier_life


@@ -47,7 +49,7 @@ m_host_t MSG_get_host_by_name(const char *name)
  * \param file a filename of a xml description of a platform. This file 
  * follows this DTD :
  *
  * \param file a filename of a xml description of a platform. This file 
  * follows this DTD :
  *

- *     \include surfxml.dtd
+ *     \include simgrid.dtd

  *
  * Here is a small example of such a platform 
  *
  *
  * Here is a small example of such a platform 
  *


@@ -55,19 +57,18 @@ m_host_t MSG_get_host_by_name(const char *name)
  *
  * Have a look in the directory examples/msg/ to have a big example.
  */
  *
  * Have a look in the directory examples/msg/ to have a big example.
  */

-void MSG_create_environment(const char *file) 
+void MSG_create_environment(const char *file)

 {
   smx_host_t *workstation = NULL;
 {
   smx_host_t *workstation = NULL;

-       int i;
+  int i;

 
 

-       SIMIX_create_environment(file);
+  SIMIX_create_environment(file);

 
 

-       /* Initialize MSG hosts */
-       workstation = SIMIX_host_get_table();
-       for (i=0; i< SIMIX_host_get_number();i++) {
-               __MSG_host_create(workstation[i], NULL);
-       }
-       xbt_free(workstation);
+  /* Initialize MSG hosts */
+  workstation = SIMIX_host_get_table();
+  for (i = 0; i < SIMIX_host_get_number(); i++) {
+    __MSG_host_create(workstation[i], NULL);
+  }
+  xbt_free(workstation);

   return;
 }
   return;
 }

-