From 17379a1c4158d8fac69e9a8626b1293077440c17 Mon Sep 17 00:00:00 2001 From: Matthias Andree Date: Sat, 24 Apr 2010 02:17:26 +0200 Subject: Complete Doxygen documentation of uid.c and related definitions. --- fetchmail.h | 29 +++++++++++++++++++---------- 1 file changed, 19 insertions(+), 10 deletions(-) (limited to 'fetchmail.h') diff --git a/fetchmail.h b/fetchmail.h index b9e38271..f2330419 100644 --- a/fetchmail.h +++ b/fetchmail.h @@ -187,26 +187,35 @@ struct runctl flag showdots; }; +/** \name idlist */ +/** Dual-use entry of singly-linked list for storing id/status or id/id2 + * pairs. */ struct idlist { - char *id; + char *id; /**< key */ union { struct { int num; - flag mark; /* UID-index information */ -#define UID_UNSEEN 0 /* hasn't been seen */ -#define UID_SEEN 1 /* seen, but not deleted */ -#define UID_DELETED 2 /* this message has been marked deleted */ -#define UID_EXPUNGED 3 /* this message has been expunged */ + flag mark; /**< UID-index information */ } - status; - char *id2; - } val; - struct idlist *next; + status; /**< value for id/status pairs */ + char *id2; /**< value for id/id2 pairs */ + } val; /**< union to store value for key \a id */ + struct idlist *next; /**< pointer to next list element */ }; +/** List of possible values for idlist::mark */ +enum { +UID_UNSEEN= 0, /**< id hasn't been seen */ +UID_SEEN= 1, /**< id was seen, but not deleted */ +UID_DELETED= 2, /**< this message has been marked deleted */ +UID_EXPUNGED= 3 /**< this message has been expunged */ +}; +/*@}*/ + + struct query; struct method /* describe methods for protocol state machine */ -- cgit v1.2.3