Just cleaned some stuff to only show undocumented functions refered

[simgrid.git] / include / gras / process.h

diff --git a/include/gras/process.h b/include/gras/process.h
index 5f4f2ca..073df64 100644 (file)
--- a/include/gras/process.h
+++ b/include/gras/process.h
@@ -1,8 +1,7 @@
-/* $Id$ */
-
 /* gras/process.h - Manipulating data related to an host.                   */
 
-/* Copyright (c) 2003, 2004 Martin Quinson. All rights reserved.            */
+/* Copyright (c) 2004, 2005, 2006, 2007, 2009, 2010. The SimGrid Team.
+ * 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. */
@@ -15,9 +14,14 @@
 
 SG_BEGIN_DECL()
 
-     void gras_agent_spawn(const char *name, void *data, xbt_main_func_t code,
-                           int argc, char *argv[], xbt_dict_t properties);
+/** \addtogroup GRAS_globals
+ * @{ */
+
+/** \brief Create a new thread */
+void gras_agent_spawn(const char *name, xbt_main_func_t code,
+                      int argc, char *argv[], xbt_dict_t properties);
 
+/** @} */
 
 /****************************************************************************/
 /* Manipulating User Data                                                   */
@@ -36,8 +40,7 @@ SG_BEGIN_DECL()
  * retrieve a reference to it.
  * 
  * 
- * For more info on this, you may want to check the relevant lesson of the GRAS tutorial:
- * \ref GRAS_tut_tour_globals
+ * For more info on this, you may want to check the relevant lesson of the GRAS tutorial online
  */
 /* @{ */
 
@@ -60,10 +63,10 @@ XBT_PUBLIC(void *) gras_userdata_set(void *ud);
  * the only solution since this macro has to compute the size to
  * malloc and should thus know the pointed type. 
  *
- * You'll find an example in the tutorial:  \ref GRAS_tut_tour_globals
+ * You'll find an example in the tutorial
  */
 #define gras_userdata_new(type) ((type*)gras_userdata_set(xbt_new0(type,1)))
 /* @} */
 
 SG_END_DECL()
-#endif /* GRAS_PROCESS_H */
+#endif                          /* GRAS_PROCESS_H */