IPP Software Navigation Tools IPP Links Communication Pan-STARRS Links

Ignore:
Timestamp:
Mar 31, 2004, 5:01:04 PM (22 years ago)
Author:
Paul Price
Message:

Standardised on /< as Doxygen comment for variable.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/archive/pslib/include/psDlist.h

    r291 r344  
    99/** Doubly-linked list element */
    1010typedef struct psDlistElem {
    11    struct psDlistElem *prev;            //!< previous link in list
    12    struct psDlistElem *next;            //!< next link in list
    13    void *data;                          //!< real data item
     11   struct psDlistElem *prev;            ///< previous link in list
     12   struct psDlistElem *next;            ///< next link in list
     13   void *data;                          ///< real data item
    1414} psDlistElem;
    1515
    1616/** Doubly-linked list */
    1717typedef struct {
    18    int n;                               //!< number of elements on list
    19    psDlistElem *head;                   //!< first element on list (may be NULL)
    20    psDlistElem *tail;                   //!< last element on list (may be NULL)
    21    psDlistElem *iter;                   //!< iteration cursor
     18   int n;                               ///< number of elements on list
     19   psDlistElem *head;                   ///< first element on list (may be NULL)
     20   psDlistElem *tail;                   ///< last element on list (may be NULL)
     21   psDlistElem *iter;                   ///< iteration cursor
    2222} psDlist;
    2323
    2424/** Special values of index into list */
    2525enum {
    26    PS_DLIST_HEAD = 0,                   //!< at head
    27    PS_DLIST_TAIL = -1,                  //!< at tail
    28    PS_DLIST_UNKNOWN = -2,               //!< unknown position
    29    PS_DLIST_PREV = -3,                  //!< previous element
    30    PS_DLIST_NEXT = -4                   //!< next element
     26   PS_DLIST_HEAD = 0,                   ///< at head
     27   PS_DLIST_TAIL = -1,                  ///< at tail
     28   PS_DLIST_UNKNOWN = -2,               ///< unknown position
     29   PS_DLIST_PREV = -3,                  ///< previous element
     30   PS_DLIST_NEXT = -4                   ///< next element
    3131};
    3232
     
    3737
    3838/** Constructor */
    39 psDlist *psDlistAlloc(void *data        //!< initial data item; may be NULL
     39psDlist *psDlistAlloc(void *data        ///< initial data item; may be NULL
    4040                      );
    4141
    4242/** Destructor */
    43 void psDlistFree(psDlist *list,         //!< list to destroy
    44                 void (*elemFree)(void *) //!< destructor for data on list
     43void psDlistFree(psDlist *list,         ///< list to destroy
     44                void (*elemFree)(void *) ///< destructor for data on list
    4545                 );
    4646
     
    4848
    4949/** Add to list */
    50 psDlist *psDlistAdd(psDlist *list,      //!< list to add to (may be NULL)
    51                     void *data,         //!< data item to add
    52                     int where           //!< index, PS_DLIST_HEAD, or PS_DLIST_TAIL
     50psDlist *psDlistAdd(psDlist *list,      ///< list to add to (may be NULL)
     51                    void *data,         ///< data item to add
     52                    int where           ///< index, PS_DLIST_HEAD, or PS_DLIST_TAIL
    5353                    );
    5454
    5555/** Append to a list */
    56 psDlist *psDlistAppend(psDlist *list,   //!< list to append to (may be NULL)
    57                        void *data       //!< data item to add
     56psDlist *psDlistAppend(psDlist *list,   ///< list to append to (may be NULL)
     57                       void *data       ///< data item to add
    5858                       );
    5959
    6060/** Remove from a list */
    61 void *psDlistRemove(psDlist *list,      //!< list to remove element from
    62                     void *data,         //!< data item to remove
    63                     int which           //!< index of item, or PS_DLIST_UNKNOWN, or PS_DLIST_NEXT, or
    64                                         //!< PS_DLIST_PREV
     61void *psDlistRemove(psDlist *list,      ///< list to remove element from
     62                    void *data,         ///< data item to remove
     63                    int which           ///< index of item, or PS_DLIST_UNKNOWN, or PS_DLIST_NEXT, or
     64                                        ///< PS_DLIST_PREV
    6565                    );
    6666/** Retrieve from a list */
    67 void *psDlistGet(const psDlist *list,   //!< list to retrieve element from
    68                  int which              //!< index of item, or PS_DLIST_NEXT, or PS_DLIST_PREV
     67void *psDlistGet(const psDlist *list,   ///< list to retrieve element from
     68                 int which              ///< index of item, or PS_DLIST_NEXT, or PS_DLIST_PREV
    6969                 );
    7070
     
    7272
    7373/** Set the iterator */
    74 void psDlistSetIterator(psDlist *list,  //!< list to retrieve element from
    75                         int where,      //!< index, PS_DLIST_HEAD, or PS_DLIST_TAIL
    76                         int which       //!< index of item, or PS_DLIST_UNKNOWN, or PS_DLIST_NEXT, or
    77                                         //!< PS_DLIST_PREV
     74void psDlistSetIterator(psDlist *list,  ///< list to retrieve element from
     75                        int where,      ///< index, PS_DLIST_HEAD, or PS_DLIST_TAIL
     76                        int which       ///< index of item, or PS_DLIST_UNKNOWN, or PS_DLIST_NEXT, or
     77                                        ///< PS_DLIST_PREV
    7878                        );
    7979
    8080/** Get next element */
    81 void *psDlistGetNext(psDlist *list,     //!< list to retrieve element from
    82                      int which          //!< index of item, or PS_DLIST_UNKNOWN, or PS_DLIST_NEXT, or
    83                                         //!< PS_DLIST_PREV
     81void *psDlistGetNext(psDlist *list,     ///< list to retrieve element from
     82                     int which          ///< index of item, or PS_DLIST_UNKNOWN, or PS_DLIST_NEXT, or
     83                                        ///< PS_DLIST_PREV
    8484                     );
    8585
    8686/** Get previous element */
    87 void *psDlistGetPrev(psDlist *list,     //!< list to retrieve element from
    88                      int which          //!< index of item, or PS_DLIST_UNKNOWN, or PS_DLIST_NEXT, or
    89                                         //!< PS_DLIST_PREV
     87void *psDlistGetPrev(psDlist *list,     ///< list to retrieve element from
     88                     int which          ///< index of item, or PS_DLIST_UNKNOWN, or PS_DLIST_NEXT, or
     89                                        ///< PS_DLIST_PREV
    9090                     );
    9191
    9292/** Convert doubly-linked list to an array */
    93 psVoidPtrArray *psDlistToArray(psDlist *dlist //!< List to convert
     93psVoidPtrArray *psDlistToArray(psDlist *dlist ///< List to convert
    9494                               );
    9595
    9696/** Convert array to a doubly-linked list */
    97 psDlist *psArrayToDlist(psVoidPtrArray *arr //!< Array to convert
     97psDlist *psArrayToDlist(psVoidPtrArray *arr ///< Array to convert
    9898                        );
    9999
Note: See TracChangeset for help on using the changeset viewer.