fix some docs

diff --git a/README.md b/README.md
index ff6ef9d18333dd10c7f22c2cf978bb7e4dc5f176..8e1d78c97f29f18e104b1cde06558a18cef5e2bf 100644 (file)
--- a/README.md
+++ b/README.md
@@ -6,7 +6,7 @@
 [![Release](https://img.shields.io/github/release/neomutt/neomutt.svg)](https://github.com/neomutt/neomutt/releases/latest "Latest Release Notes")
 [![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://github.com/neomutt/neomutt/blob/master/COPYRIGHT.md "Copyright Statement")
 [![Code build](https://img.shields.io/travis/neomutt/neomutt.svg?label=code)](https://travis-ci.org/neomutt/neomutt "Latest Automatic Code Build")
-[![Coverity Scan](https://img.shields.io/coverity/scan/8495.svg)](https://scan.coverity.com/projects/neomutt-neomutt "Latest Code Static Analysis)
+[![Coverity Scan](https://img.shields.io/coverity/scan/8495.svg)](https://scan.coverity.com/projects/neomutt-neomutt "Latest Code Static Analysis")
 [![Website build](https://img.shields.io/travis/neomutt/neomutt.github.io.svg?label=website)](https://travis-ci.org/neomutt/neomutt.github.io "Latest Website Test")
 
 ## What is NeoMutt?
@@ -69,7 +69,7 @@ sorted through them, fixed them up and documented them.
 - Releases:        https://github.com/neomutt/neomutt/releases/latest
 - Questions/Bugs:  https://github.com/neomutt/neomutt/issues
 - Website:         https://neomutt.org
-- IRC:             irc://irc.freenode.net/neomutt - please be patient.
+- IRC:             [irc://irc.freenode.net/neomutt](https://webchat.freenode.net/ "IRC Web Client") - please be patient.
   We're a small group, so our answer might take some time.
 - Mailinglists:    [neomutt-users](mailto:neomutt-users-request@neomutt.org?subject=subscribe)
   and [neomutt-devel](mailto:neomutt-devel-request@neomutt.org?subject=subscribe)

diff --git a/conn/sasl_plain.c b/conn/sasl_plain.c
index ea7a578d097ad8e04bae6768d237ff0544ea9b06..55b149948ac9f99c1a2d35796009e78fbd001c3d 100644 (file)
--- a/conn/sasl_plain.c
+++ b/conn/sasl_plain.c
@@ -31,16 +31,21 @@
 #include "mutt/mutt.h"
 
 /**
- * mutt_sasl_plain_msg - Create an SASL command
- * @param buf    Buffer to store the command
- * @param buflen Length of the buffer
- * @param cmd    SASL command
- * @param authz  Authorisation
- * @param user   Username
+ * mutt_sasl_plain_msg - Construct a base64 encoded SASL PLAIN message
+ * @param buf    Destination buffer
+ * @param buflen Available space in the destination buffer
+ * @param cmd    Protocol-specific string the prepend to the PLAIN message
+ * @param authz  Authorization identity
+ * @param user   Authentication identity (username)
  * @param pass   Password
  * @retval >0 Success, number of chars in the command string
  * @retval  0 Error
  *
+ * This function can be used to build a protocol-specific SASL Response message
+ * using the PLAIN mechanism. The protocol specific command is given in the cmd
+ * parameter. The function appends a space, encodes the string derived from
+ * authz\0user\0pass using base64 encoding, and stores the result in buf.
+ *
  * authz, user, and pass can each be up to 255 bytes, making up for a 765 bytes
  * string. Add the two NULL bytes in between plus one at the end and we get
  * 768.

diff --git a/conn/sasl_plain.h b/conn/sasl_plain.h
index cd1705c7ec8ccebf632745bf4a0b1ff04ce171c7..759745842b8eeb2d35536c2102f6ba885f4ba1b0 100644 (file)
--- a/conn/sasl_plain.h
+++ b/conn/sasl_plain.h
@@ -25,23 +25,6 @@
 
 #include <stdlib.h>
 
-/**
- * mutt_sasl_plain_msg - construct a base64 encoded SASL PLAIN message
- * @param buf    Destination buffer
- * @param buflen Available space in the destination buffer
- * @param cmd    Protocol-specific string the prepend to the PLAIN message
- * @param authz  Authorization identity
- * @param user   Authentication identity (username)
- * @param pass   Password
- * @retval num Bytes written to buf
- *
- * This function can be used to build a protocol-specific SASL Response message
- * using the PLAIN mechanism. The protocol specific command is given in the cmd
- * parameter. The function appends a space, encodes the string derived from
- * authz\0user\0pass using base64 encoding, and stores the result in buf.
- *
- * Example usages for IMAP and SMTP, respectively:
- */
 size_t mutt_sasl_plain_msg(char *buf, size_t buflen, const char *cmd,
                            const char *authz, const char *user, const char *pass);
 

diff --git a/doc/manual.xml.head b/doc/manual.xml.head
index 37c960a131ea041e9eba2b1dc549781981f739af..eec9e8cd100c8b5801755122ca503bea1f96c4db 100644 (file)
--- a/doc/manual.xml.head
+++ b/doc/manual.xml.head
@@ -7217,18 +7217,18 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&%4c?)%*  %s"
               <row>
                 <entry>~h <emphasis>EXPR</emphasis></entry>
                 <entry>
-                   messages which contain <emphasis>EXPR</emphasis>in the
-                   message header ***)
+                  messages which contain <emphasis>EXPR</emphasis>in the
+                  message header ***)
                 </entry>
               </row>
               <row>
                 <entry>=h <emphasis>STRING</emphasis></entry>
                 <entry>
-                   If IMAP is enabled, like ~h but searches for
-                   <emphasis>STRING</emphasis>on the server, rather than
-                   downloading each message and searching it locally;
-                   <emphasis>STRING</emphasis>must be of the form
-                   <quote>header: substring</quote>(see below).
+                  If IMAP is enabled, like ~h but searches for
+                  <emphasis>STRING</emphasis>on the server, rather than
+                  downloading each message and searching it locally;
+                  <emphasis>STRING</emphasis>must be of the form
+                  <quote>header: substring</quote>(see below).
                 </entry>
               </row>
               <row>
@@ -7420,8 +7420,8 @@ set index_format="%4C %Z %{%b %d} %-15.15L (%?l?%4l&amp;%4c?)%*  %s"
               <row>
                 <entry>~X [ <emphasis>MIN</emphasis>]-[ <emphasis>MAX</emphasis>]</entry>
                 <entry>
-                   messages with <emphasis>MIN</emphasis>to
-                   <emphasis>MAX</emphasis>attachments *) ****)
+                  messages with <emphasis>MIN</emphasis>to
+                  <emphasis>MAX</emphasis>attachments *) ****)
                 </entry>
               </row>
               <row>

diff --git a/mutt_notmuch.c b/mutt_notmuch.c
index 57cdd2ef714a8e0a68b2100115323d55811cc2bd..1840613d84d4d2a18635127bff204a17895ae628 100644 (file)
--- a/mutt_notmuch.c
+++ b/mutt_notmuch.c
@@ -1091,7 +1091,7 @@ static struct Header *get_mutt_header(struct Context *ctx, notmuch_message_t *ms
 }
 
 /**
- * append_message - Associcate a message
+ * append_message - Associate a message
  * @param ctx   Mailbox
  * @param q     Notmuch query
  * @param msg   Notmuch message

diff --git a/pop.c b/pop.c
index a454883e79cda6ca331c331d8ef231f38e53e9a7..07dd0d2bc847e39da6085d46af7724c61c4f712b 100644 (file)
--- a/pop.c
+++ b/pop.c
@@ -1031,7 +1031,7 @@ fail:
 }
 
 /**
- * mx_comp_ops - Mailbox callback functions
+ * mx_pop_ops - Mailbox callback functions
  */
 struct MxOps mx_pop_ops = {
   .open = pop_open_mailbox,