doxygenification

[simgrid.git] / include / xbt / context.h

diff --git a/include/xbt/context.h b/include/xbt/context.h
index e035c7b..fd744d3 100644 (file)
--- a/include/xbt/context.h
+++ b/include/xbt/context.h
@@ -9,9 +9,27 @@
 #define _XBT_CONTEXT_H
 
 #include "xbt/misc.h"
+#include "xbt/dynar.h" /* void_f_pvoid_t */
 
-typedef struct s_xbt_context *xbt_context_t;
-typedef int(*xbt_context_function_t)(int argc, char *argv[]);
+/** @addtogroup XBT_context
+ *  
+ *  INTERNALS OF SIMGRID, DON'T USE IT.
+ *
+ *  This is a portable to Unix and Windows context implementation.
+ *
+ * @{
+ */
+
+/** @name Context types
+ *  @{
+ */
+
+  /** @brief A context */
+  typedef struct s_xbt_context *xbt_context_t;
+  /** @brief A context function */
+  typedef int(*xbt_context_function_t)(int argc, char *argv[]);
+
+/*@}*/
 
 void xbt_context_init(void);
 void xbt_context_exit(void);
@@ -20,8 +38,9 @@ xbt_context_t xbt_context_new(xbt_context_function_t code,
                              void_f_pvoid_t startup_func, void *startup_arg,
                              void_f_pvoid_t cleanup_func, void *cleanup_arg,
                              int argc, char *argv[]);
+void xbt_context_free(xbt_context_t context);
 void xbt_context_start(xbt_context_t context);
 void xbt_context_yield(void);
 void xbt_context_schedule(xbt_context_t context);
-
+/*@} */
 #endif                         /* _XBT_CONTEXT_H */