X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/f9541e9299d8464d8a4d13ada458a7883a36a9d5..380344ba7ad3d0ed0f7fb8f86990e83b97f39831:/include/xbt/config.h

diff --git a/include/xbt/config.h b/include/xbt/config.h
index b5df791099..1131871c98 100644
--- a/include/xbt/config.h
+++ b/include/xbt/config.h
@@ -1,20 +1,16 @@
-/* config - Dictionary where the type of each cell is provided.            */
-
+/* config - Dictionary where the type of each cell is provided.             */
 /* This is useful to build named structs, like option or property sets.     */
 
-/* Copyright (c) 2004-2007, 2009-2014. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2004-2017. 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. */
 
-#ifndef _XBT_CONFIG_H_
-#define _XBT_CONFIG_H_
+#ifndef XBT_CONFIG_H
+#define XBT_CONFIG_H
 
-#include "xbt/dynar.h"
 #include <stdarg.h>
-
-SG_BEGIN_DECL()
+#include <xbt/dynar.h>
 
 /** @addtogroup XBT_config
  *  @brief Changing the configuration of SimGrid components (grounding feature)
@@ -43,27 +39,7 @@ SG_BEGIN_DECL()
  *
  *  \section XBT_cfg_ex Example of use
  *
- *  \dontinclude config.c
- *
- *  First, let's create a configuration set with some registered variables.
- *  This must be done by the configurable library before the user interactions.
- *
- *  \skip make_set
- *  \until end_of_make_set
- *
- *  Now, set and get a single value
- *  \skip get_single_value
- *  \skip int
- *  \until cfg_free
- *
- *  And now, set and get a multiple value
- *  \skip get_multiple_value
- *  \skip dyn
- *  \until cfg_free
- *
- *  All those functions throws mismatch_error if asked to deal with an  unregistered variable.
- *  \skip myset
- *  \until cfg_free
+ *  TBD
  */
 /** @defgroup XBT_cfg_use User interface: changing values
  *  @ingroup XBT_config
@@ -89,6 +65,8 @@ typedef simgrid::config::Config* xbt_cfg_t;
 typedef void* xbt_cfg_t;
 #endif
 
+SG_BEGIN_DECL()
+
 XBT_PUBLIC(void) xbt_cfg_set_parse(const char *options);
 
 /* Set the value of the cell \a name in \a cfg with the provided value.*/
@@ -121,7 +99,7 @@ XBT_PUBLIC(int) xbt_cfg_is_default_value(const char *name);
 /** \brief Callback types. They get the name of the modified entry, and the position of the changed value */
 typedef void (*xbt_cfg_cb_t) (const char * name);
 
-XBT_PUBLIC(xbt_cfg_t) xbt_cfg_new(void);
+XBT_PUBLIC(xbt_cfg_t) xbt_cfg_new();
 XBT_PUBLIC(void) xbt_cfg_free(xbt_cfg_t * cfg);
 XBT_PUBLIC(void) xbt_cfg_dump(const char *name, const char *indent, xbt_cfg_t cfg);
 
@@ -140,8 +118,8 @@ XBT_PUBLIC(void) xbt_cfg_register_string (const char *name, const char*default_v
 XBT_PUBLIC(void) xbt_cfg_register_boolean(const char *name, const char*default_val,xbt_cfg_cb_t cb_set, const char *desc);
 XBT_PUBLIC(void) xbt_cfg_register_alias(const char *newname, const char *oldname);
 
-XBT_PUBLIC(void) xbt_cfg_aliases(void);
-XBT_PUBLIC(void) xbt_cfg_help(void);
+XBT_PUBLIC(void) xbt_cfg_aliases();
+XBT_PUBLIC(void) xbt_cfg_help();
 
 /*  @} */
 /** @defgroup XBT_cfg_get Getting the stored values
@@ -165,4 +143,4 @@ XBT_PUBLIC(int)    xbt_cfg_get_boolean(const char *name);
 /** @} */
 
 SG_END_DECL()
-#endif                          /* _XBT_CONFIG_H_ */
+#endif /* XBT_CONFIG_H */