doxygen: fix comments

diff --git a/account.c b/account.c
index fe7693f0ac860ed877798dee5c4c2797d555c18f..15356c8210df99e76f86da0f4940646ae1a442eb 100644 (file)
--- a/account.c
+++ b/account.c
@@ -20,8 +20,6 @@
  * this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-/* remote host account manipulation (POP/IMAP) */
-
 #include "config.h"
 #include <stdio.h>
 #include <string.h>

diff --git a/curs_lib.c b/curs_lib.c
index 141ab47922dd728ebedd8a0e29074aafa89fba4d..c4bdcc9d3ae924e230bdd809b57a849df762bdec 100644 (file)
--- a/curs_lib.c
+++ b/curs_lib.c
@@ -1142,7 +1142,7 @@ int mutt_addwch(wchar_t wc)
 }
 
 /**
- * mutt_format_string - Format a string, like snprintf()
+ * mutt_simple_format - Format a string, like snprintf()
  *
  * This formats a string, a bit like snprintf (dest, destlen, "%-*.*s",
  * min_width, max_width, s), except that the widths refer to the number of

diff --git a/editmsg.c b/editmsg.c
index a10cdf7d80fc863876b238c0ab2d25937d149b38..3818068e02a1dc421d2d794bfd3a8fb8a8c1df12 100644 (file)
--- a/editmsg.c
+++ b/editmsg.c
@@ -105,9 +105,7 @@ static int edit_one_message(struct Context *ctx, struct Header *cur)
     goto bail;
   }
 
-  /*
-   * 2002-09-05 me@sigpipe.org
-   * The file the user is going to edit is not a real mbox, so we need to
+  /* The file the user is going to edit is not a real mbox, so we need to
    * truncate the last newline in the temp file, which is logically part of
    * the message separator, and not the body of the message.  If we fail to
    * remove it, the message will grow by one line each time the user edits
@@ -169,11 +167,8 @@ static int edit_one_message(struct Context *ctx, struct Header *cur)
   else
     of = MUTT_ADD_FROM;
 
-  /*
-   * XXX - we have to play games with the message flags to avoid
-   * problematic behavior with maildir folders.
-   *
-   */
+  /* XXX - we have to play games with the message flags to avoid
+   * problematic behavior with maildir folders.  */
 
   o_read = cur->read;
   o_old = cur->old;
@@ -219,7 +214,6 @@ bail:
   else if (rc == -1)
     mutt_message(_("Error. Preserving temporary file: %s"), tmp);
 
-
   return rc;
 }
 

diff --git a/format_flags.h b/format_flags.h
index 6295efaf70e44ee4dc1a46f474937f04e0cdf347..501ec84aedf3e6c0c04c531768068bc296586736 100644 (file)
--- a/format_flags.h
+++ b/format_flags.h
@@ -1,6 +1,6 @@
 /**
  * @file
- * Flags to control mutt_FormatString()
+ * Flags to control mutt_expando_format()
  *
  * @authors
  * Copyright (C) 2017 Richard Russon <rich@flatcap.org>
@@ -45,13 +45,8 @@ typedef const char *format_t(char *dest, size_t destlen, size_t col, int cols,
                              const char *ifstring, const char *elsestring,
                              unsigned long data, enum FormatFlag flags);
 
-void mutt_expando_format(char *dest,         /* output buffer */
-                       size_t destlen,     /* output buffer len */
-                       size_t col,         /* starting column (nonzero when called recursively) */
-                       int cols,           /* maximum columns */
-                       const char *src,    /* template string */
-                       format_t *callback, /* callback for processing */
-                       unsigned long data, /* callback data */
-                       enum FormatFlag flags); /* callback flags */
+void mutt_expando_format(char *dest, size_t destlen, size_t col, int cols,
+                         const char *src, format_t *callback,
+                         unsigned long data, enum FormatFlag flags);
 
 #endif /* _MUTT_FORMAT_FLAGS_H */

diff --git a/init.h b/init.h
index c0fd122a6ee8f3b82fd15bb036985f909879e5fc..10e1c9fa37a4ccc3452931089c780c1ea4fee047 100644 (file)
--- a/init.h
+++ b/init.h
@@ -328,7 +328,6 @@ struct Option MuttVars[] = {
   ** message.  The send-menu may still be accessed once you have finished
   ** editing the body of your message.
   ** .pp
-  ** .pp
   ** \fBNote:\fP when this option is \fIset\fP, you cannot use send-hooks that depend
   ** on the recipients when composing a new (non-reply) message, as the initial
   ** list of recipients is empty.

diff --git a/mutt_options.h b/mutt_options.h
index bbbb6f54db643cc10341c10b78e97d94a6b6cb75..41be66c0f2a9a31da6e2f7500b9c89273f2c7329 100644 (file)
--- a/mutt_options.h
+++ b/mutt_options.h
@@ -57,7 +57,7 @@ struct Buffer;
 struct Option
 {
   const char *option; /**< user-visible name */
-  short type;         /**< varible type, e.g. *DT_STR */
+  short type;         /**< variable type, e.g. *DT_STR */
   short flags;        /**< notification flags, e.g. R_PAGER */
   unsigned long data; /**< pointer to the global variable */
   unsigned long init; /**< initial value */

diff --git a/ncrypt/crypt.c b/ncrypt/crypt.c
index 4027b48a5227591db211c31a5d717affbb23ef73..e7af1004aa298beeb73658c26ceb8c55235acd85 100644 (file)
--- a/ncrypt/crypt.c
+++ b/ncrypt/crypt.c
@@ -911,7 +911,7 @@ static void crypt_fetch_signatures(struct Body ***signatures, struct Body *a, in
 }
 
 /**
- * mutt_signed_handler - Verify a "multipart/signed" body.
+ * mutt_signed_handler - Verify a "multipart/signed" body
  */
 int mutt_signed_handler(struct Body *a, struct State *s)
 {

diff --git a/rfc2047.c b/rfc2047.c
index 7d4f04b2c019a916f0e084030be676e4a266519b..a3416478a662e69edf6bc8d92df4ccaeccd79014 100644 (file)
--- a/rfc2047.c
+++ b/rfc2047.c
@@ -402,7 +402,6 @@ static size_t choose_block(char *d, size_t dlen, int col, const char *fromcode,
  * @param[out] elen     Buffer length
  * @param[in]  specials Special characters to be encoded
  *
- *
  * Place the result of RFC-2047-encoding (d, dlen) into the dynamically
  * allocated buffer (e, elen). The input data is in charset fromcode
  * and is converted into a charset chosen from charsets.

diff --git a/sidebar.c b/sidebar.c
index c13a983d337e79ffc43b633b43cc73c44149f958..3772e478e2a73a8e766a0b5d871f6b62cc9ece8f 100644 (file)
--- a/sidebar.c
+++ b/sidebar.c
@@ -274,7 +274,7 @@ static void make_sidebar_entry(char *buf, unsigned int buflen, int width,
 }
 
 /**
- * cb_qsort_sbe - qsort callback to sort SBENTRYs
+ * cb_qsort_sbe - qsort callback to sort SbEntry's
  * @param a First  SbEntry to compare
  * @param b Second SbEntry to compare
  * @retval -1 a precedes b
@@ -579,7 +579,7 @@ static int select_page_up(void)
 }
 
 /**
- * prepare_sidebar - Prepare the list of SBENTRYs for the sidebar display
+ * prepare_sidebar - Prepare the list of SbEntry's for the sidebar display
  * @param page_size  The number of lines on a page
  * @retval false No, don't draw the sidebar
  * @retval true  Yes, draw the sidebar

diff --git a/url.c b/url.c
index c47598514cf46bfd18773267494c075c74dec1d4..238dec5b1b497626c3a0eaf94c170c71b5ca5dc2 100644 (file)
--- a/url.c
+++ b/url.c
@@ -169,7 +169,7 @@ static int ciss_parse_userhost(struct CissUrl *ciss, char *src)
 }
 
 /**
- * url_parse_ciss - Fill in CissUrl.
+ * url_parse_ciss - Fill in CissUrl
  *
  * char* elements are pointers into src, which is modified by this call
  * (duplicate it first if you need to).

diff --git a/version.c b/version.c
index 9da21b6cb64e9c903e7ff9d5b9a767841a450707..a667113135bca18e2c75e848ecce8845a637fa81 100644 (file)
--- a/version.c
+++ b/version.c
@@ -295,7 +295,7 @@ static struct CompileOptions comp_opts[] = {
 };
 
 /**
- * print_compile_options - Print a list of enabled/disabled features.
+ * print_compile_options - Print a list of enabled/disabled features
  *
  * Two lists are generated and passed to this function:
  *