doxygen: add struct/enum/union templates

account.h

@@ -27,7 +27,9 @@
 
 struct CissUrl;
 
-/* account types */
+/**
+ * enum AccountType - account types
+ */
 enum AccountType
 {
   MUTT_ACCT_TYPE_NONE = 0,
@@ -44,6 +46,9 @@ enum AccountType
 #define MUTT_ACCT_PASS (1 << 3)
 #define MUTT_ACCT_SSL (1 << 4)
 
+/**
+ * struct Account - Login details for a remote server
+ */
 struct Account
 {
   char user[64];

address.h

@@ -25,6 +25,9 @@
 
 #include <stdbool.h>
 
+/**
+ * struct Address - An email address
+ */
 struct Address
 {
   char *personal; /**< real name of address */

alias.h

@@ -28,6 +28,9 @@
 struct Envelope;
 struct Address;
 
+/**
+ * struct Alias - A shortcut for an email address
+ */
 struct Alias
 {
   struct Alias *self; /* XXX - ugly hack */

attach.h

@@ -32,6 +32,9 @@ struct Menu;
 struct Header;
 struct Body;
 
+/**
+ * struct AttachPtr - An email to which things will be attached
+ */
 struct AttachPtr
 {
   struct Body *content;

bcache.c

@@ -38,6 +38,9 @@
 
 static int mutt_bcache_move(struct BodyCache *bcache, const char *id, const char *newid);
 
+/**
+ * struct BodyCache - Local cache of email bodies
+ */
 struct BodyCache
 {
   char path[_POSIX_PATH_MAX];

bcache.h

@@ -61,7 +61,7 @@ FILE *mutt_bcache_get(struct BodyCache *bcache, const char *id);
  * mutt_bcache_put - Create a file in the Body Cache
  * @param bcache Body Cache from mutt_bcache_open()
  * @param id     Per-mailbox unique identifier for the message
- * @param tmp    Returned FILE* is in a temporary location.
+ * @param tmp    Returned FILE* is in a temporary location
  *               If set, use mutt_bcache_commit to put it into place
  * @return FILE* on success, NULL on failure
  */

body.h

@@ -27,6 +27,9 @@
 #include <time.h>
 #include <sys/types.h>
 
+/**
+ * struct Body - The body of an email
+ */
 struct Body
 {
   char *xtype;                  /**< content-type if x-unknown */

browser.c

@@ -93,6 +93,9 @@ static struct Mapping FolderNewsHelp[] = {
 };
 #endif
 
+/**
+ * struct Folder - A folder/dir in the browser
+ */
 struct Folder
 {
   struct FolderFile *ff;

browser.h

@@ -27,6 +27,9 @@
 #include <sys/types.h>
 #include <time.h>
 
+/**
+ * struct FolderFile - Browser entry representing a folder/dir
+ */
 struct FolderFile
 {
   mode_t mode;
@@ -58,6 +61,9 @@ struct FolderFile
   bool tagged : 1;
 };
 
+/**
+ * struct BrowserState - State of the file/mailbox browser
+ */
 struct BrowserState
 {
   struct FolderFile *entry;

buffer.h

@@ -23,6 +23,9 @@
 
 #include <stddef.h>
 
+/**
+ * struct Buffer - String manipulation buffer
+ */
 struct Buffer
 {
   char *data;   /**< pointer to data */

buffy.h

@@ -35,6 +35,9 @@ struct stat;
 #define MUTT_NAMED   1
 #define MUTT_VIRTUAL 2
 
+/**
+ * struct Buffy - A mailbox
+ */
 struct Buffy
 {
   char path[_POSIX_PATH_MAX];

charset.c

@@ -478,6 +478,9 @@ int mutt_convert_string(char **ps, const char *from, const char *to, int flags)
  * Used in sendlib.c for converting from mutt's Charset
  */
 
+/**
+ * struct FgetConv - Cursor for converting a file's encoding
+ */
 struct FgetConv
 {
   FILE *file;
@@ -491,6 +494,9 @@ struct FgetConv
   ICONV_CONST char **inrepls;
 };
 
+/**
+ * struct FgetConvNot - A dummy converter
+ */
 struct FgetConvNot
 {
   FILE *file;

color.c

@@ -65,6 +65,9 @@ static int ColorQuoteSize;
 
 #define COLOR_DEFAULT (-2)
 
+/**
+ * struct ColorList - A set of colors
+ */
 struct ColorList
 {
   short fg;

compose.c

@@ -76,7 +76,9 @@ static const char *There_are_no_attachments = N_("There are no attachments.");
     break;                                                                     \
   }
 
-
+/**
+ * enum HeaderField - Ordered list of headers for the compose screen
+ */
 enum HeaderField
 {
   HDR_FROM = 0,
@@ -526,6 +528,9 @@ static void update_idx(struct Menu *menu, struct AttachPtr **idx, short idxlen)
   return;
 }
 
+/**
+ * struct ComposeRedrawData - Keep track when the compose screen needs redrawing
+ */
 struct ComposeRedrawData
 {
   struct Header *msg;

content.h

@@ -25,7 +25,11 @@
 
 #include <stdbool.h>
 
-/* Information that helps in determining the Content-* of an attachment */
+/**
+ * struct Content - Info about an attachment
+ *
+ * Information that helps in determining the Content-* of an attachment
+ */
 struct Content
 {
   long hibin;      /**< 8-bit characters */

context.h

@@ -28,7 +28,9 @@
 #include <sys/types.h>
 #include <time.h>
 
-/* ACL Rights */
+/**
+ * enum AclRights - ACL Rights
+ */
 enum AclRights
 {
   MUTT_ACL_LOOKUP = 0,
@@ -46,6 +48,9 @@ enum AclRights
   RIGHTSMAX
 };
 
+/**
+ * struct Context - The "current" mailbox
+ */
 struct Context
 {
   char *path;

doc/makedoc.c

@@ -45,6 +45,9 @@ extern int optind;
 
 #define BUFFSIZE 2048
 
+/**
+ * enum OutputFormats - Documentation output formats
+ */
 enum OutputFormats
 {
   F_CONF,
@@ -66,6 +69,9 @@ enum OutputFormats
 #define D_IL (1 << 10)
 #define D_TT (1 << 11)
 
+/**
+ * enum SpecialChars - All specially-treated characters
+ */
 enum SpecialChars
 {
   SP_START_EM,
@@ -935,6 +941,9 @@ static int handle_docline(char *l, FILE *out, int docstat)
  * following string definitions!
  */
 
+/**
+ * enum DataType - User-variable types
+ */
 enum DataType
 {
   DT_NONE = 0,
@@ -951,7 +960,7 @@ enum DataType
   DT_MBCHARTBL
 };
 
-struct
+struct VariableTypes
 {
   char *machine;
   char *human;

enter.c

@@ -39,7 +39,9 @@
 #include "options.h"
 #include "protos.h"
 
-/* redraw flags for mutt_enter_string() */
+/**
+ * enum RedrawFlags - redraw flags for mutt_enter_string()
+ */
 enum RedrawFlags
 {
   MUTT_REDRAW_INIT = 1, /**< go to end of line and redraw */

enter_state.h

@@ -26,6 +26,9 @@
 #include <stddef.h>
 #include "lib.h"
 
+/**
+ * struct EnterState - Keep our place when entering a string
+ */
 struct EnterState
 {
   wchar_t *wbuf;

envelope.h

@@ -26,6 +26,9 @@
 #include <stdbool.h>
 #include "lib.h"
 
+/**
+ * struct Envelope - The header of an email
+ */
 struct Envelope
 {
   struct Address *return_path;

format_flags.h

@@ -25,7 +25,9 @@
 
 #include <stddef.h>
 
-/* flags for mutt_FormatString() */
+/**
+ * enum FormatFlag - Control the behaviour of mutt_FormatString()
+ */
 enum FormatFlag
 {
   MUTT_FORMAT_FORCESUBJ   = (1 << 0), /**< print the subject even if unchanged */

group.h

@@ -32,13 +32,19 @@ struct Buffer;
 #define MUTT_GROUP   0
 #define MUTT_UNGROUP 1
 
+/**
+ * struct Group - A set of email addresses
+ */
 struct Group
 {
   struct Address *as;
   struct RxList *rs;
   char *name;
 };
 
+/**
+ * struct GroupContext - A set of Groups
+ */
 struct GroupContext
 {
   struct Group *g;

handler.c

@@ -474,6 +474,9 @@ static void decode_uuencoded(struct State *s, long len, int istext, iconv_t cd)
 
 #define IndentSize (4)
 
+/**
+ * enum RichAttribs - Rich text attributes
+ */
 enum RichAttribs
 {
   RICH_PARAM = 0,
@@ -513,6 +516,9 @@ static const struct
   { NULL, -1 },
 };
 
+/**
+ * struct EnrichedState - State of enriched-text parser
+ */
 struct EnrichedState
 {
   wchar_t *buffer;

hash.h

@@ -25,18 +25,27 @@
 
 #include <stdbool.h>
 
+/**
+ * union HashKey - The data item stored in a HashElem
+ */
 union HashKey {
   const char *strkey;
   unsigned int intkey;
 };
 
+/**
+ * struct HashElem - The item stored in a Hash Table
+ */
 struct HashElem
 {
   union HashKey key;
   void *data;
   struct HashElem *next;
 };
 
+/**
+ * struct Hash - A Hash Table
+ */
 struct Hash
 {
   int nelem;
@@ -71,6 +80,9 @@ void int_hash_delete(struct Hash *table, unsigned int intkey, const void *data,
 
 void hash_destroy(struct Hash **ptr, void (*destroy)(void *));
 
+/**
+ * struct HashWalkState - Cursor to iterate through a Hash Table
+ */
 struct HashWalkState
 {
   int index;

hcache/backend.h

@@ -95,6 +95,9 @@ typedef void (*hcache_close_t)(void **ctx);
  */
 typedef const char *(*hcache_backend_t)(void);
 
+/**
+ * struct HcacheOps - Header Cache API
+ */
 struct HcacheOps
 {
   const char       *name;

hcache/bdb.c

@@ -37,6 +37,9 @@
 #include "lib.h"
 #include "mx.h"
 
+/**
+ * struct HcacheDbCtx - Berkeley DB context
+ */
 struct HcacheDbCtx
 {
   DB_ENV *env;