doxygen: Address struct members

diff --git a/address/address.h b/address/address.h
index 6c79bd320aecd25f11d723b54c5e31b58ce6f41f..3fdd947d3862e3454182fa4df5fa5201a97a3c4e 100644 (file)
--- a/address/address.h
+++ b/address/address.h
@@ -33,12 +33,12 @@
  */
 struct Address
 {
-  char *personal; /**< real name of address */
-  char *mailbox;  /**< mailbox and host address */
-  bool group : 1; /**< group mailbox? */
-  bool is_intl : 1;
-  bool intl_checked : 1;
-  TAILQ_ENTRY(Address) entries;
+  char *personal;               ///< Real name of address
+  char *mailbox;                ///< Mailbox and host address
+  bool group : 1;               ///< Group mailbox?
+  bool is_intl : 1;             ///< International Domain Name
+  bool intl_checked : 1;        ///< Checked for IDN?
+  TAILQ_ENTRY(Address) entries; ///< Linked list
 };
 TAILQ_HEAD(AddressList, Address);
 
@@ -62,35 +62,35 @@ extern const char AddressSpecials[];
 #define address_error(num) AddressErrors[num]
 
 /* Utility functions that don't use struct Address or struct AddressList */
-void            mutt_addr_cat(char *buf, size_t buflen, const char *value, const char *specials);
-bool            mutt_addr_valid_msgid(const char *msgid);
+void mutt_addr_cat        (char *buf, size_t buflen, const char *value, const char *specials);
+bool mutt_addr_valid_msgid(const char *msgid);
 
 /* Functions that work on a single struct Address */
-bool            mutt_addr_cmp(const struct Address *a, const struct Address *b);
-struct Address *mutt_addr_copy(const struct Address *addr);
-struct Address *mutt_addr_create(const char *personal, const char *mailbox);
+bool            mutt_addr_cmp        (const struct Address *a, const struct Address *b);
+struct Address *mutt_addr_copy       (const struct Address *addr);
+struct Address *mutt_addr_create     (const char *personal, const char *mailbox);
 const char *    mutt_addr_for_display(const struct Address *a);
-void            mutt_addr_free(struct Address **a);
-struct Address *mutt_addr_new(void);
-bool            mutt_addr_to_local(struct Address *a);
-size_t          mutt_addr_write(char *buf, size_t buflen, struct Address *addr, bool display);
+void            mutt_addr_free       (struct Address **a);
+struct Address *mutt_addr_new        (void);
+bool            mutt_addr_to_local   (struct Address *a);
+size_t          mutt_addr_write      (char *buf, size_t buflen, struct Address *addr, bool display);
 
 /* Functions that work on struct AddressList */
-void                mutt_addrlist_append(struct AddressList *al, struct Address *a);
-void                mutt_addrlist_clear(struct AddressList *al);
-void                mutt_addrlist_copy(struct AddressList *dst, const struct AddressList *src, bool prune);
-int                 mutt_addrlist_count_recips(const struct AddressList *al);
-void                mutt_addrlist_dedupe(struct AddressList *al);
-bool                mutt_addrlist_equal(const struct AddressList *ala, const struct AddressList *alb);
-int                 mutt_addrlist_parse(struct AddressList *al, const char *s);
-int                 mutt_addrlist_parse2(struct AddressList *al, const char *s);
-void                mutt_addrlist_prepend(struct AddressList *al, struct Address *a);
-void                mutt_addrlist_qualify(struct AddressList *al, const char *host);
-int                 mutt_addrlist_remove(struct AddressList *al, const char *mailbox);
-void                mutt_addrlist_remove_xrefs(const struct AddressList *a, struct AddressList *b);
-bool                mutt_addrlist_search(const struct Address *needle, const struct AddressList *haystack);
-int                 mutt_addrlist_to_local(struct AddressList *al);
-int                 mutt_addrlist_to_intl(struct AddressList *al, char **err);
-size_t              mutt_addrlist_write(char *buf, size_t buflen, const struct AddressList *al, bool display);
+void   mutt_addrlist_append      (struct AddressList *al, struct Address *a);
+void   mutt_addrlist_clear       (struct AddressList *al);
+void   mutt_addrlist_copy        (struct AddressList *dst, const struct AddressList *src, bool prune);
+int    mutt_addrlist_count_recips(const struct AddressList *al);
+void   mutt_addrlist_dedupe      (struct AddressList *al);
+bool   mutt_addrlist_equal       (const struct AddressList *ala, const struct AddressList *alb);
+int    mutt_addrlist_parse       (struct AddressList *al, const char *s);
+int    mutt_addrlist_parse2      (struct AddressList *al, const char *s);
+void   mutt_addrlist_prepend     (struct AddressList *al, struct Address *a);
+void   mutt_addrlist_qualify     (struct AddressList *al, const char *host);
+int    mutt_addrlist_remove      (struct AddressList *al, const char *mailbox);
+void   mutt_addrlist_remove_xrefs(const struct AddressList *a, struct AddressList *b);
+bool   mutt_addrlist_search      (const struct Address *needle, const struct AddressList *haystack);
+int    mutt_addrlist_to_intl     (struct AddressList *al, char **err);
+int    mutt_addrlist_to_local    (struct AddressList *al);
+size_t mutt_addrlist_write       (char *buf, size_t buflen, const struct AddressList *al, bool display);
 
 #endif /* MUTT_EMAIL_ADDRESS_H */

diff --git a/address/group.h b/address/group.h
index 15208e4e8bdda131af8c3ce31465ef7ba71f676a..2c8ab6defa394c19971d0aec6514af6e5800251f 100644 (file)
--- a/address/group.h
+++ b/address/group.h
@@ -29,17 +29,17 @@
 #include "mutt/mutt.h"
 #include "address.h"
 
-#define MUTT_GROUP   0
-#define MUTT_UNGROUP 1
+#define MUTT_GROUP   0  ///< 'group' config command
+#define MUTT_UNGROUP 1  ///< 'ungroup' config command
 
 /**
  * struct Group - A set of email addresses
  */
 struct Group
 {
-  struct AddressList al;
-  struct RegexList rs;
-  char *name;
+  struct AddressList al; ///< List of Addresses
+  struct RegexList rs;   ///< Group Regex patterns
+  char *name;            ///< Name of Group
 };
 
 /**
@@ -47,23 +47,22 @@ struct Group
  */
 struct GroupNode
 {
-  struct Group *group;
-  STAILQ_ENTRY(GroupNode) entries;
+  struct Group *group;             ///< Address Group
+  STAILQ_ENTRY(GroupNode) entries; ///< Linked list
 };
 STAILQ_HEAD(GroupList, GroupNode);
 
-void mutt_grouplist_init(void);
-void mutt_grouplist_free(void);
-void mutt_grouplist_add(struct GroupList *gl, struct Group *group);
-void mutt_grouplist_add_addrlist(struct GroupList *gl, struct AddressList *a);
-int  mutt_grouplist_add_regex(struct GroupList *gl, const char *s,
-                              int flags, struct Buffer *err);
-void mutt_grouplist_destroy(struct GroupList *gl);
-void mutt_grouplist_clear(struct GroupList *gl);
-int  mutt_grouplist_remove_regex(struct GroupList *gl, const char *s);
+void mutt_grouplist_add            (struct GroupList *gl, struct Group *group);
+void mutt_grouplist_add_addrlist   (struct GroupList *gl, struct AddressList *a);
+int  mutt_grouplist_add_regex      (struct GroupList *gl, const char *s, int flags, struct Buffer *err);
+void mutt_grouplist_clear          (struct GroupList *gl);
+void mutt_grouplist_destroy        (struct GroupList *gl);
+void mutt_grouplist_free           (void);
+void mutt_grouplist_init           (void);
 int  mutt_grouplist_remove_addrlist(struct GroupList *gl, struct AddressList *a);
+int  mutt_grouplist_remove_regex   (struct GroupList *gl, const char *s);
 
-bool mutt_group_match(struct Group *g, const char *s);
+bool          mutt_group_match  (struct Group *g, const char *s);
 struct Group *mutt_pattern_group(const char *pat);
 
 #endif /* MUTT_GROUP_H */

diff --git a/address/idna2.h b/address/idna2.h
index 2410efb2f19aa9a1795200c3a65259785aff769b..930a1610e19c1542a2afc380b32bd1bf44354ade 100644 (file)
--- a/address/idna2.h
+++ b/address/idna2.h
@@ -34,6 +34,6 @@ extern bool C_IdnEncode;
 char *      mutt_idna_intl_to_local(const char *user, const char *domain, int flags);
 char *      mutt_idna_local_to_intl(const char *user, const char *domain);
 const char *mutt_idna_print_version(void);
-int         mutt_idna_to_ascii_lz(const char *input, char **output, int flags);
+int         mutt_idna_to_ascii_lz  (const char *input, char **output, int flags);
 
 #endif /* MUTT_EMAIL_IDNA_H */