doxygen: mailbox backends

diff --git a/compress.c b/compress.c
index 4c9b959e0cd6db82abd601ebf66551894af8dac6..f77586fc6de56c21d3182f7533972df9954b33ce 100644 (file)
--- a/compress.c
+++ b/compress.c
@@ -969,7 +969,7 @@ int comp_path_parent(char *buf, size_t buflen)
 
 // clang-format off
 /**
- * struct mx_comp_ops - Mailbox callback functions for compressed mailboxes
+ * struct mx_comp_ops - Compressed mailbox - Implements ::MxOps 
  *
  * Compress only uses open, close and check.
  * The message functions are delegated to mbox.

diff --git a/imap/imap.c b/imap/imap.c
index 86b9ea553a56bc564b95abd0106ed4a9e8dc0cd6..191e1e5babd3731a8e7cef98f0ad5c106ad17d59 100644 (file)
--- a/imap/imap.c
+++ b/imap/imap.c
@@ -2790,7 +2790,7 @@ int imap_path_parent(char *buf, size_t buflen)
 
 // clang-format off
 /**
- * struct mx_imap_ops - Mailbox callback functions for IMAP mailboxes
+ * struct mx_imap_ops - IMAP mailbox - Implements ::MxOps
  */
 struct MxOps mx_imap_ops = {
   .magic            = MUTT_IMAP,

diff --git a/maildir/mh.c b/maildir/mh.c
index 8c68fc8a5369491bce59d5795fb7ac5af370ced6..7e158903a9ad058f65a3dc0945b5e37e706bdb06 100644 (file)
--- a/maildir/mh.c
+++ b/maildir/mh.c
@@ -2991,7 +2991,7 @@ int maildir_path_parent(char *buf, size_t buflen)
 
 // clang-format off
 /**
- * struct mx_maildir_ops - Mailbox callback functions for Maildir mailboxes
+ * struct mx_maildir_ops - Maildir mailbox - Implements ::MxOps
  */
 struct MxOps mx_maildir_ops = {
   .magic            = MUTT_MAILDIR,
@@ -3014,7 +3014,7 @@ struct MxOps mx_maildir_ops = {
 };
 
 /**
- * struct mx_mh_ops - Mailbox callback functions for MH mailboxes
+ * struct mx_mh_ops - MH mailbox - Implements ::MxOps
  */
 struct MxOps mx_mh_ops = {
   .magic            = MUTT_MH,

diff --git a/mbox/mbox.c b/mbox/mbox.c
index fc2f6e8e3392e11b4e83a00fd57bd5a4754c1e55..1a6fe1e60e61fd36b2e1f8d3489e4dc5600925f3 100644 (file)
--- a/mbox/mbox.c
+++ b/mbox/mbox.c
@@ -1436,7 +1436,7 @@ int mbox_path_parent(char *buf, size_t buflen)
 
 // clang-format off
 /**
- * struct mx_mbox_ops - Mailbox callback functions for mbox mailboxes
+ * struct mx_mbox_ops - Mbox mailbox - Implements ::MxOps
  */
 struct MxOps mx_mbox_ops = {
   .magic            = MUTT_MBOX,
@@ -1459,7 +1459,7 @@ struct MxOps mx_mbox_ops = {
 };
 
 /**
- * struct mx_mmdf_ops - Mailbox callback functions for MMDF mailboxes
+ * struct mx_mmdf_ops - MMDF mailbox - Implements ::MxOps
  */
 struct MxOps mx_mmdf_ops = {
   .magic            = MUTT_MMDF,

diff --git a/mx.h b/mx.h
index ae19d04ec6d0f899b0dc137b46e59000f939789d..a1e24e21cf239b4ef269e6fc8ff7366fd47fdcf2 100644 (file)
--- a/mx.h
+++ b/mx.h
@@ -93,8 +93,8 @@ struct Message
 /**
  * struct MxOps - The Mailbox API
  *
- * Each backend provides a set of functions through which the mailbox, messages
- * and tags are manipulated.
+ * Each backend provides a set of functions through which the mailbox, messages,
+ * tags and paths are manipulated.
  */
 struct MxOps
 {

diff --git a/nntp/nntp.c b/nntp/nntp.c
index 389a3dede95c9fe03af8ea52eed18e30d0fd7661..a30e4168ee25d04a0b9d4699b6fd60650d2774a7 100644 (file)
--- a/nntp/nntp.c
+++ b/nntp/nntp.c
@@ -2690,7 +2690,7 @@ int nntp_path_parent(char *buf, size_t buflen)
 
 // clang-format off
 /**
- * struct mx_nntp_ops - Mailbox callback functions for NNTP mailboxes
+ * struct mx_nntp_ops - NNTP mailbox - Implements ::MxOps
  */
 struct MxOps mx_nntp_ops = {
   .magic            = MUTT_NNTP,

diff --git a/notmuch/mutt_notmuch.c b/notmuch/mutt_notmuch.c
index d2aa353475ee6393886591aedb2706457dad209c..7b4e96d87a86e23746ed2ea1a5029c720ab66d27 100644 (file)
--- a/notmuch/mutt_notmuch.c
+++ b/notmuch/mutt_notmuch.c
@@ -2822,7 +2822,7 @@ int nm_path_parent(char *buf, size_t buflen)
 
 // clang-format off
 /**
- * struct mx_notmuch_ops - Mailbox callback functions for Notmuch mailboxes
+ * struct mx_notmuch_ops - Notmuch mailbox - Implements ::MxOps
  */
 struct MxOps mx_notmuch_ops = {
   .magic            = MUTT_NOTMUCH,

diff --git a/pop/pop.c b/pop/pop.c
index 8e34ded73a8c01df7a4b93746b3f7f4fcd594070..e204720f683632191cbfd55bd8dc11bd84b0427e 100644 (file)
--- a/pop/pop.c
+++ b/pop/pop.c
@@ -1121,7 +1121,7 @@ int pop_path_parent(char *buf, size_t buflen)
 
 // clang-format off
 /**
- * mx_pop_ops - Mailbox callback functions for POP mailboxes
+ * mx_pop_ops - POP mailbox - Implements ::MxOps
  */
 struct MxOps mx_pop_ops = {
   .magic            = MUTT_POP,