Document last changes

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

diff --git a/include/gras/cond.h b/include/gras/cond.h
index 100e1b2..99ac277 100644 (file)
--- a/include/gras/cond.h
+++ b/include/gras/cond.h
@@ -3,7 +3,7 @@
 /* gras/cond.h - public interface to conditional execution                  */
 /*                (specific parts for SG or RL)                             */
  
-/* Copyright (c) 2004 Martin Quinson. All rights reserved.                  */
+/* Copyright (c) 2003, 2004 Martin Quinson. 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. */
@@ -13,23 +13,26 @@
 
 #include "xbt/misc.h" /* BEGIN_DECL */
 
-BEGIN_DECL
+BEGIN_DECL()
 
-/**
- * gras_if_RL:
+/** @addtogroup GRAS_cond
+ *  @brief Handling code specific to the simulation or to the reality (Virtualization).
  * 
- * Returns true only if the program runs on real life
+ *  Please note that those are real functions and not pre-processor defines. This is to ensure
+ *  that the same object code can be linked against the SG library or the RL one without recompilation.
+ * 
+ *  @{
  */
+  
+/** \brief Returns true only if the program runs on real life */
 int gras_if_RL(void);
 
-/**
- * gras_if_SG:
- * 
- * Returns true only if the program runs within the simulator
- */
+/** \brief Returns true only if the program runs within the simulator */
 int gras_if_SG(void);
 
-END_DECL
+/** @} */
+
+END_DECL()
 
 #endif /* GRAS_COND_H */