From 1e18ccad74ce3d49299f1da9022c5d5e4ee76918 Mon Sep 17 00:00:00 2001 From: mquinson Date: Thu, 30 Mar 2006 20:35:29 +0000 Subject: [PATCH] Remove the old crufty navigation bars git-svn-id: svn+ssh://scm.gforge.inria.fr/svn/simgrid/simgrid/trunk@2021 48e7efb5-ca39-0410-a469-dd3cf9ba447f --- include/xbt/asserts.h | 4 ---- include/xbt/config.h | 21 --------------------- include/xbt/dict.h | 25 ------------------------- include/xbt/dynar.h | 30 ------------------------------ include/xbt/fifo.h | 19 ------------------- include/xbt/heap.h | 3 --- include/xbt/log.h | 6 ------ include/xbt/set.h | 17 ----------------- include/xbt/swag.h | 17 ----------------- 9 files changed, 142 deletions(-) diff --git a/include/xbt/asserts.h b/include/xbt/asserts.h index 56acf090be..d5b9b9da5c 100644 --- a/include/xbt/asserts.h +++ b/include/xbt/asserts.h @@ -19,10 +19,6 @@ SG_BEGIN_DECL() * @addtogroup XBT_error * @brief Those are the SimGrid version of the good ol' assert macro. * - *
Top [\ref index]::[\ref XBT_API] - *
Prev [\ref XBT_log] - *
Next [\ref XBT_config]
- * * You can pass them a format message and arguments, just as if it where a printf. * It is converted to a CRITICALn logging request. * diff --git a/include/xbt/config.h b/include/xbt/config.h index 27b927a744..da9457da06 100644 --- a/include/xbt/config.h +++ b/include/xbt/config.h @@ -19,11 +19,6 @@ SG_BEGIN_DECL() /** @addtogroup XBT_config * @brief Changing the configuration of SimGrid components (grounding feature) * - *
Top [\ref index]::[\ref XBT_API] - *
Prev [\ref XBT_error] - *
Next [\ref XBT_dynar] - *
Down [\ref XBT_cfg_use]
- * * All modules of the SimGrid toolkit can be configured with this API. * User modules and libraries can also use these facilities to handle * their own configuration. @@ -82,10 +77,6 @@ SG_BEGIN_DECL() /** @defgroup XBT_cfg_use User interface: changing values * @ingroup XBT_config * - *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_config] - *
Prev - *
Next [\ref XBT_cfg_decl]
- * * This is the only interface you should use unless you want to let your * own code become configurable with this. * @@ -144,10 +135,6 @@ void xbt_cfg_empty(xbt_cfg_t cfg, const char *name); /** @defgroup XBT_cfg_decl Configuration type declaration and memory management * @ingroup XBT_config * - *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_config] - *
Prev [\ref XBT_cfg_use] - *
Next [\ref XBT_cfg_register]
- * * @{ */ @@ -175,10 +162,6 @@ void xbt_cfg_empty(xbt_cfg_t cfg, const char *name); /** @defgroup XBT_cfg_register Registering stuff * @ingroup XBT_config * - *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_config] - *
Prev [\ref XBT_cfg_decl] - *
Next [\ref XBT_cfg_get]
- * * This how to add new variables to an existing configuration set. Use it to make your code * configurable. * @@ -196,10 +179,6 @@ void xbt_cfg_empty(xbt_cfg_t cfg, const char *name); /** @defgroup XBT_cfg_get Getting the stored values * @ingroup XBT_config * - *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_config] - *
Prev [\ref XBT_cfg_register] - *
Next
- * * This is how to retrieve the values stored in the configuration set. This is only * intended to configurable code, naturally. * diff --git a/include/xbt/dict.h b/include/xbt/dict.h index daa0a4cef5..686f396987 100644 --- a/include/xbt/dict.h +++ b/include/xbt/dict.h @@ -19,11 +19,6 @@ SG_BEGIN_DECL() /** @addtogroup XBT_dict * @brief The dictionnary data structure (comparable to hash tables) * - *
Top [\ref index]::[\ref XBT_API] - *
Prev [\ref XBT_dynar] - *
Next [\ref XBT_set] - *
Down [\ref XBT_dict_cons]
- * * This section describes the API to a dictionnary structure that * associates as string to a void* key. Even if it provides the same * functionnality than an hash table, the implementation differs and the @@ -45,10 +40,6 @@ SG_BEGIN_DECL() /** @defgroup XBT_dict_cons Dict constructor and destructor * @ingroup XBT_dict * - *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_dict] - *
Prev - *
Next [\ref XBT_dict_basic]
- * * @{ */ @@ -61,10 +52,6 @@ SG_BEGIN_DECL() /** @defgroup XBT_dict_basic Dictionnaries basic usage * @ingroup XBT_dict * - *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_dict] - *
Prev [\ref XBT_dict_cons] - *
Next [\ref XBT_dict_nnul]
- * * Careful, those functions assume that the key is null-terminated. * * @{ @@ -81,10 +68,6 @@ SG_BEGIN_DECL() /** @defgroup XBT_dict_nnul Dictionnaries with non-nul terminated keys * @ingroup XBT_dict * - *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_dict] - *
Prev [\ref XBT_dict_basic] - *
Next [\ref XBT_dict_curs]
- * * Those functions work even with non-null terminated keys. * * @{ @@ -101,10 +84,6 @@ SG_BEGIN_DECL() /** @defgroup XBT_dict_curs Cursors on dictionnaries * @ingroup XBT_dict * - *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_dict] - *
Prev [\ref XBT_dict_nnul] - *
Next [\ref XBT_dict_multi]
- * * Don't get impressed, there is a lot of functions here, but traversing a * dictionnary is imediate with the xbt_dict_foreach macro. * You only need the other functions in rare cases (they are not used directly in SG itself). @@ -151,10 +130,6 @@ SG_BEGIN_DECL() /** @defgroup XBT_dict_multi Multi-level dictionnaries * @ingroup XBT_dict * - *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_dict] - *
Prev [\ref XBT_dict_curs] - *
Next
- * * They can be seen as dictionnary of multiple keys or as dictionnary of * dictionnary of ... of data. Most of the functions here work the same way * than their simple dictionnary counterpart. diff --git a/include/xbt/dynar.h b/include/xbt/dynar.h index ab156bbb58..4eea121cb7 100644 --- a/include/xbt/dynar.h +++ b/include/xbt/dynar.h @@ -17,12 +17,6 @@ SG_BEGIN_DECL() /** @addtogroup XBT_dynar * @brief DynArr are dynamically sized vector which may contain any type of variables. * - *
Up [\ref index]::[\ref XBT_API] - *
Prev [\ref XBT_config] - *
Next [\ref XBT_dict] - *
Down \ref XBT_dynar_cons\n\ref XBT_dynar_array\n\ref XBT_dynar_perl\n\ref XBT_dynar_ctn\n\ref XBT_dynar_speed\n\ref XBT_dynar_cursor - *
- * * These are the SimGrid version of the dynamically size arrays, which all C programmer recode one day or another. * * For performance concerns, the content of DynArr must be homogeneous (in @@ -61,10 +55,6 @@ SG_BEGIN_DECL() /** @defgroup XBT_dynar_cons Dynar constructor and destructor * @ingroup XBT_dynar * - *
Up [\ref index]::[\ref XBT_API]::[\ref XBT_dynar] - *
Jump to --\>\ref XBT_dynar_cons\<--\n\ref XBT_dynar_array\n\ref XBT_dynar_perl\n\ref XBT_dynar_ctn\n\ref XBT_dynar_speed\n\ref XBT_dynar_cursor - *
- * * @{ */ /** \brief Dynar data type (opaque type) */ @@ -85,10 +75,6 @@ SG_BEGIN_DECL() /** @defgroup XBT_dynar_array Dynar as a regular array * @ingroup XBT_dynar * - *
Up [\ref index]::[\ref XBT_API]::[\ref XBT_dynar] - *
Jump to \ref XBT_dynar_cons\n--\>\ref XBT_dynar_array\<--\n\ref XBT_dynar_perl\n\ref XBT_dynar_ctn\n\ref XBT_dynar_speed\n\ref XBT_dynar_cursor - *
- * * @{ */ @@ -104,10 +90,6 @@ SG_BEGIN_DECL() /** @defgroup XBT_dynar_perl Perl-like use of dynars * @ingroup XBT_dynar * - *
Up [\ref index]::[\ref XBT_API]::[\ref XBT_dynar] - *
Jump to \ref XBT_dynar_cons\n\ref XBT_dynar_array\n--\>\ref XBT_dynar_perl\<--\n\ref XBT_dynar_ctn\n\ref XBT_dynar_speed\n\ref XBT_dynar_cursor - *
- * * @{ */ @@ -121,10 +103,6 @@ SG_BEGIN_DECL() /** @defgroup XBT_dynar_ctn Direct manipulation to the dynars content * @ingroup XBT_dynar * - *
Up [\ref index]::[\ref XBT_API]::[\ref XBT_dynar] - *
Jump to \ref XBT_dynar_cons\n\ref XBT_dynar_array\n\ref XBT_dynar_perl\n--\>\ref XBT_dynar_ctn\<--\n\ref XBT_dynar_speed\n\ref XBT_dynar_cursor - *
- * * Those functions do not retrive the content, but only their address. * * @{ @@ -139,10 +117,6 @@ SG_BEGIN_DECL() /** @defgroup XBT_dynar_speed Speed optimized access to dynars of scalars * @ingroup XBT_dynar * - *
Up [\ref index]::[\ref XBT_API]::[\ref XBT_dynar] - *
Jump to \ref XBT_dynar_cons\n\ref XBT_dynar_array\n\ref XBT_dynar_perl\n\ref XBT_dynar_ctn\n--\>\ref XBT_dynar_speed\<--\n\ref XBT_dynar_cursor - *
- * * While the other functions use a memcpy to retrive the content into the * user provided area, those ones use a regular affectation. It only works * for scalar values, but should be a little faster. @@ -179,10 +153,6 @@ SG_BEGIN_DECL() /** @defgroup XBT_dynar_cursor Cursors on dynar * @ingroup XBT_dynar * - *
Up [\ref index]::[\ref XBT_API]::[\ref XBT_dynar] - *
Jump to \ref XBT_dynar_cons\n\ref XBT_dynar_array\n\ref XBT_dynar_perl\n\ref XBT_dynar_ctn\n\ref XBT_dynar_speed\n--\>\ref XBT_dynar_cursor\<-- - *
- * * Cursors are used to iterate over the structure. Never add elements to the * DynArr during the traversal. To remove elements, use the * xbt_dynar_cursor_rm() function diff --git a/include/xbt/fifo.h b/include/xbt/fifo.h index 46becae17e..1da1eb44b8 100644 --- a/include/xbt/fifo.h +++ b/include/xbt/fifo.h @@ -14,11 +14,6 @@ SG_BEGIN_DECL() /** @addtogroup XBT_fifo * @brief This section describes the API to generic workqueue. * - *
Top [\ref index]::[\ref XBT_API] - *
Prev [\ref XBT_set] - *
Next [\ref XBT_swag] - *
Down [\ref XBT_fifo_cons]
- * * These functions provide the same kind of functionnality as dynamic arrays but in time O(1). * However these functions use malloc/free way too much often. */ @@ -26,9 +21,6 @@ SG_BEGIN_DECL() /** @defgroup XBT_fifo_cons Fifo constructor and destructor * @ingroup XBT_fifo * - *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_fifo] - *
Prev - *
Next [\ref XBT_fifo_perl]
* @{ */ @@ -47,9 +39,6 @@ void xbt_fifo_free(xbt_fifo_t); /** @defgroup XBT_fifo_perl Fifo perl-like functions * @ingroup XBT_fifo * - *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_fifo] - *
Prev [\ref XBT_fifo_cons] - *
Next [\ref XBT_fifo_direct]
* @{ */ xbt_fifo_item_t xbt_fifo_push(xbt_fifo_t, void *); @@ -63,10 +52,6 @@ int xbt_fifo_is_in(xbt_fifo_t, void *); /** @defgroup XBT_fifo_direct Direct access to fifo elements * @ingroup XBT_fifo * - *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_fifo] - *
Prev [\ref XBT_fifo_perl] - *
Next [\ref XBT_fifo_misc]
- * * @{ */ @@ -108,10 +93,6 @@ xbt_fifo_item_t xbt_fifo_get_prev_item(xbt_fifo_item_t i); /** @defgroup XBT_fifo_misc Misc fifo functions * @ingroup XBT_fifo * - *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_fifo] - *
Prev [\ref XBT_fifo_direct] - *
Next
- * * @{ */ void **xbt_fifo_to_array(xbt_fifo_t); diff --git a/include/xbt/heap.h b/include/xbt/heap.h index 368107b283..27afafceda 100644 --- a/include/xbt/heap.h +++ b/include/xbt/heap.h @@ -14,9 +14,6 @@ /** @addtogroup XBT_heap * @brief This section describes the API to generic heap with O(log(n)) access. * - *
Top [\ref index]::[\ref XBT_API] - *
Prev [\ref XBT_swag] - *
Next
* @{ */ /* @brief heap datatype */ diff --git a/include/xbt/log.h b/include/xbt/log.h index 54a77cb490..bf2025e083 100644 --- a/include/xbt/log.h +++ b/include/xbt/log.h @@ -10,10 +10,6 @@ /** @addtogroup XBT_log * @brief A generic logging facility in the spirit of log4j (grounding feature) * - *
Top [\ref index]::[\ref XBT_API] - *
Prev [\ref XBT_ex] - *
Next [\ref XBT_error] - *
Down [\ref XBT_log_cats]
* */ @@ -21,8 +17,6 @@ * \ingroup XBT_log * \brief (automatically extracted) * - *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_log]
- * * This is the list of all existing log categories in SimGrid. * This list was automatically extracted from the source code by * the src/xbt_log_extract_hierarchy utility. diff --git a/include/xbt/set.h b/include/xbt/set.h index c62a835667..fd36001e6c 100644 --- a/include/xbt/set.h +++ b/include/xbt/set.h @@ -17,11 +17,6 @@ SG_BEGIN_DECL() /** @addtogroup XBT_set * @brief A data container consisting in \ref XBT_dict and \ref XBT_dynar * - *
Top [\ref index]::[\ref XBT_API] - *
Prev [\ref XBT_dict] - *
Next [\ref XBT_fifo] - *
Down [\ref XBT_set_cons]
- * * The elements stored in such a data structure can be retrieve both by * name and by ID. For this to work, the first fields of the structures * stored must begin with: @@ -41,10 +36,6 @@ SG_BEGIN_DECL() /** @defgroup XBT_set_cons Set and set elements, constructor/destructor * @ingroup XBT_set * - *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_set] - *
Prev - *
Next [\ref XBT_set_basic]
- * * @{ */ /** \brief Opaque type representing a set */ @@ -66,10 +57,6 @@ typedef struct xbt_set_elm_ * xbt_set_elm_t; /** @defgroup XBT_set_basic Sets basic usage * @ingroup XBT_set * - *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_set] - *
Prev [\ref XBT_set_cons] - *
Next [\ref XBT_set_curs]
- * * @{ */ @@ -83,10 +70,6 @@ xbt_set_elm_t xbt_set_get_by_id (xbt_set_t set, int id); /** @defgroup XBT_set_curs Sets cursors * @ingroup XBT_set * - *
Top [\ref index]::[\ref XBT_API]::[\ref XBT_set] - *
Prev [\ref XBT_set_basic] - *
Next
- * * \warning Don't add or remove entries to the cache while traversing * * @{ diff --git a/include/xbt/swag.h b/include/xbt/swag.h index 863b8a52c7..99568258b4 100644 --- a/include/xbt/swag.h +++ b/include/xbt/swag.h @@ -19,11 +19,6 @@ * @addtogroup XBT_swag * @brief a O(1) set based on linked lists * - *
Top [\ref index]::[\ref XBT_API] - *
Prev [\ref XBT_fifo] - *
Next [\ref XBT_heap] - *
Down [\ref XBT_swag_type]
- * * Warning, this module is done to be efficient and performs tons of * cast and dirty things. So make sure you know what you are doing while using it. * It is basically a fifo but with restrictions so that @@ -35,10 +30,6 @@ /** @defgroup XBT_swag_type Swag types @ingroup XBT_swag -
Top [\ref index]::[\ref XBT_API]::[\ref XBT_swag] -
Prev -
Next [\ref XBT_swag_func]
- Specific set. @@ -92,10 +83,6 @@ typedef struct xbt_swag { /** @defgroup XBT_swag_func SWAG functions * @ingroup XBT_swag -
Top [\ref index]::[\ref XBT_API]::[\ref XBT_swag] -
Prev [\ref XBT_swag_type] -
Next [\ref XBT_swag_curs]
- * @{ */ @@ -136,10 +123,6 @@ static _XBT_INLINE void *xbt_swag_getFirst(xbt_swag_t swag) * \defgroup XBT_swag_curs Swag cursor * @ingroup XBT_swag -
Top [\ref index]::[\ref XBT_API]::[\ref XBT_swag] -
Prev [\ref XBT_swag_func] -
Next
- * Iterates over the whole swag. * * @{ */ -- 2.20.1