Browse Source

update comment list.h

Thibaud Lambert 12 years ago
parent
commit
9e2f01a57f
1 changed files with 24 additions and 24 deletions
  1. 24 24
      src/common/list.h

+ 24 - 24
src/common/list.h

@@ -24,48 +24,48 @@
  * *********************************************************
  * *********************************************************
  * LIST_TYPE(FOO, contenu);
  * LIST_TYPE(FOO, contenu);
  *  - déclare les types suivants
  *  - déclare les types suivants
- *      + pour les cellules : FOO
- *      + pour les listes : FOO_list
- *      + pour les itérateurs : FOO
+ *      + pour les cellules : struct FOO
+ *      + pour les listes : struct FOO_list
+ *      + pour les itérateurs : struct FOO
  *  - déclare les accesseurs suivants :
  *  - déclare les accesseurs suivants :
  *     * création d'une cellule
  *     * création d'une cellule
- *   FOO*       FOO_new(void);
+ *   struct FOO*	FOO_new(void);
  *     * suppression d'une cellule
  *     * suppression d'une cellule
- *   void       FOO_delete(FOO*);
+ *   void		FOO_delete(struct FOO*);
  *     * création d'une liste (vide)
  *     * création d'une liste (vide)
- *   FOO_list*  FOO_list_new(void);
+ *   struct FOO_list*	FOO_list_new(void);
  *     * suppression d'une liste
  *     * suppression d'une liste
- *   void       FOO_list_delete(FOO_list*);
+ *   void		FOO_list_delete(struct FOO_list*);
  *     * teste si une liste est vide
  *     * teste si une liste est vide
- *   int        FOO_list_empty(FOO_list*);
+ *   int		FOO_list_empty(struct FOO_list*);
  *     * retire un élément de la liste
  *     * retire un élément de la liste
- *   void       FOO_list_erase(FOO_list*, FOO*);
+ *   void		FOO_list_erase(struct FOO_list*, struct FOO*);
  *     * ajoute une élément en queue de liste
  *     * ajoute une élément en queue de liste
- *   void       FOO_list_push_back(FOO_list*, FOO*);
+ *   void		FOO_list_push_back(struct FOO_list*, struct FOO*);
  *     * ajoute un élément en tête de list
  *     * ajoute un élément en tête de list
- *   void       FOO_list_push_front(FOO_list*, FOO*);
+ *   void		FOO_list_push_front(struct FOO_list*, struct FOO*);
  *     * ajoute la deuxième liste à la fin de la première liste
  *     * ajoute la deuxième liste à la fin de la première liste
- *   FOO*       FOO_list_push_list_back(FOO_list*, FOO_list*);
+ *   struct FOO*	FOO_list_push_list_back(struct FOO_list*, struct FOO_list*);
  *     * ajoute la première liste au début de la deuxième liste
  *     * ajoute la première liste au début de la deuxième liste
- *   FOO*       FOO_list_push_list_front(FOO_list*, FOO_list*);
+ *   struct FOO*	FOO_list_push_list_front(struct FOO_list*, struct FOO_list*);
  *     * retire l'élément en queue de liste
  *     * retire l'élément en queue de liste
- *   FOO*       FOO_list_pop_back(FOO_list*);
+ *   struct FOO*	FOO_list_pop_back(struct FOO_list*);
  *     * retire l'élement en tête de liste
  *     * retire l'élement en tête de liste
- *   FOO*       FOO_list_pop_front(FOO_list*);
+ *   struct FOO*	FOO_list_pop_front(struct FOO_list*);
  *     * retourne l'élément en queue de liste
  *     * retourne l'élément en queue de liste
- *   FOO*       FOO_list_back(FOO_list*);
+ *   struct FOO*	FOO_list_back(struct FOO_list*);
  *     * retourne l'élement en tête de liste
  *     * retourne l'élement en tête de liste
- *   FOO*       FOO_list_front(FOO_list*);
+ *   struct FOO*	FOO_list_front(struct FOO_list*);
  *     * vérifie si la liste chainée est cohérente
  *     * vérifie si la liste chainée est cohérente
- *   int	FOO_list_check(FOO_list*);
+ *   int		FOO_list_check(struct FOO_list*);
  *     *
  *     *
- *   FOO*       FOO_list_begin(FOO_list*);
+ *   struct FOO*	FOO_list_begin(struct FOO_list*);
  *     *
  *     *
- *   FOO*       FOO_list_end(FOO_list*);
+ *   struct FOO*	FOO_list_end(struct FOO_list*);
  *     *
  *     *
- *   FOO*       FOO_list_next(FOO*)
+ *   struct FOO*	FOO_list_next(struct FOO*)
  *     *
  *     *
- *   int        FOO_list_size(FOO_list*)
+ *   int		FOO_list_size(struct FOO_list*)
  * *********************************************************
  * *********************************************************
  * Exemples d'utilisation :
  * Exemples d'utilisation :
  *  - au départ, on a :
  *  - au départ, on a :
@@ -83,12 +83,12 @@
  *  - allocation d'une liste vide :
  *  - allocation d'une liste vide :
  *  struct ma_structure_list * l = ma_structure_list_new();
  *  struct ma_structure_list * l = ma_structure_list_new();
  *  - ajouter un élément 'e' en tête de la liste 'l' :
  *  - ajouter un élément 'e' en tête de la liste 'l' :
- *  ma_structure * e = ma_structure_new();
+ *  struct ma_structure * e = ma_structure_new();
  *  e->a = 0;
  *  e->a = 0;
  *  e->b = 0;
  *  e->b = 0;
  *  ma_structure_list_push_front(l, e);
  *  ma_structure_list_push_front(l, e);
  *  - itérateur de liste :
  *  - itérateur de liste :
- *  ma_structure * i;
+ *  struct ma_structure * i;
  *  for(i  = ma_structure_list_begin(l);
  *  for(i  = ma_structure_list_begin(l);
  *      i != ma_structure_list_end(l);
  *      i != ma_structure_list_end(l);
  *      i  = ma_structure_list_next(i))
  *      i  = ma_structure_list_next(i))