From f01a95a00b5ef9ef9d273b18e04a545368d73b67 Mon Sep 17 00:00:00 2001 From: Richard Russon Date: Fri, 21 Jul 2017 23:54:05 +0100 Subject: [PATCH] doxygen: fix comments --- account.c | 2 -- curs_lib.c | 2 +- editmsg.c | 12 +++--------- format_flags.h | 13 ++++--------- init.h | 1 - mutt_options.h | 2 +- ncrypt/crypt.c | 2 +- rfc2047.c | 1 - sidebar.c | 4 ++-- url.c | 2 +- version.c | 2 +- 11 files changed, 14 insertions(+), 29 deletions(-) diff --git a/account.c b/account.c index fe7693f0a..15356c821 100644 --- a/account.c +++ b/account.c @@ -20,8 +20,6 @@ * this program. If not, see . */ -/* remote host account manipulation (POP/IMAP) */ - #include "config.h" #include #include diff --git a/curs_lib.c b/curs_lib.c index 141ab4792..c4bdcc9d3 100644 --- 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 a10cdf7d8..3818068e0 100644 --- 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 6295efaf7..501ec84ae 100644 --- 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 @@ -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 c0fd122a6..10e1c9fa3 100644 --- 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 bbbb6f54d..41be66c0f 100644 --- 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 4027b48a5..e7af1004a 100644 --- 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 7d4f04b2c..a3416478a 100644 --- 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 c13a983d3..3772e478e 100644 --- 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 c47598514..238dec5b1 100644 --- 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 9da21b6cb..a66711313 100644 --- 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: * -- 2.40.0