[gmime: 3/4] Fixed up documentation comments

[Jeffrey Stedfast <fejj src gnome org>]

commit ac2ba25a05638bfbc37ef434985fc8f1d919768d
Author: Jeffrey Stedfast <jestedfa microsoft com>
Date:   Thu Mar 30 08:58:18 2017 -0400

    Fixed up documentation comments

 gmime/gmime-header.c     |   85 +++++++++++++++++++++++++++++++++++++++++++++-
 gmime/gmime-references.c |    4 +-
 2 files changed, 86 insertions(+), 3 deletions(-)
---
diff --git a/gmime/gmime-header.c b/gmime/gmime-header.c
index aa8bcb4..ef94c9d 100644
--- a/gmime/gmime-header.c
+++ b/gmime/gmime-header.c
@@ -434,6 +434,18 @@ g_mime_header_write_to_stream (GMimeHeader *header, GMimeFormatOptions *options,
 }
 
 
+/**
+ * g_mime_header_format_content_disposition:
+ * @header: a #GMimeHeader
+ * @options: a #GMimeFormatOptions
+ * @value: a Content-Disposition header value
+ * @charset: a charset (note: unused)
+ *
+ * Parses the @value and then re-formats it to conform to the formatting options,
+ * folding the value if necessary.
+ *
+ * Returns: a newly allocated string containing the reformatted value.
+ **/
 char *
 g_mime_header_format_content_disposition (GMimeHeader *header, GMimeFormatOptions *options, const char 
*value, const char *charset)
 {
@@ -459,6 +471,18 @@ g_mime_header_format_content_disposition (GMimeHeader *header, GMimeFormatOption
 }
 
 
+/**
+ * g_mime_header_format_content_type:
+ * @header: a #GMimeHeader
+ * @options: a #GMimeFormatOptions
+ * @value: a Content-Type header value
+ * @charset: a charset (note: unused)
+ *
+ * Parses the @value and then re-formats it to conform to the formatting options,
+ * folding the value if necessary.
+ *
+ * Returns: a newly allocated string containing the reformatted value.
+ **/
 char *
 g_mime_header_format_content_type (GMimeHeader *header, GMimeFormatOptions *options, const char *value, 
const char *charset)
 {
@@ -486,6 +510,18 @@ g_mime_header_format_content_type (GMimeHeader *header, GMimeFormatOptions *opti
 }
 
 
+/**
+ * g_mime_header_format_message_id:
+ * @header: a #GMimeHeader
+ * @options: a #GMimeFormatOptions
+ * @value: a Message-Id or Content-Id header value
+ * @charset: a charset (note: unused)
+ *
+ * Parses the @value and then re-formats it to conform to the formatting options,
+ * folding the value if necessary.
+ *
+ * Returns: a newly allocated string containing the reformatted value.
+ **/
 char *
 g_mime_header_format_message_id (GMimeHeader *header, GMimeFormatOptions *options, const char *value, const 
char *charset)
 {
@@ -495,6 +531,18 @@ g_mime_header_format_message_id (GMimeHeader *header, GMimeFormatOptions *option
 }
 
 
+/**
+ * g_mime_header_format_references:
+ * @header: a #GMimeHeader
+ * @options: a #GMimeFormatOptions
+ * @value: a References or In-Reply-To header value
+ * @charset: a charset (note: unused)
+ *
+ * Parses the @value and then re-formats it to conform to the formatting options,
+ * folding the value if necessary.
+ *
+ * Returns: a newly allocated string containing the reformatted value.
+ **/
 char *
 g_mime_header_format_references (GMimeHeader *header, GMimeFormatOptions *options, const char *value, const 
char *charset)
 {
@@ -541,6 +589,18 @@ g_mime_header_format_references (GMimeHeader *header, GMimeFormatOptions *option
 }
 
 
+/**
+ * g_mime_header_format_addrlist:
+ * @header: a #GMimeHeader
+ * @options: a #GMimeFormatOptions
+ * @value: a Sender, From, Reply-To, To, Cc, or Bcc header value
+ * @charset: a charset (note: unused)
+ *
+ * Parses the @value and then re-formats it to conform to the formatting options,
+ * folding the value if necessary.
+ *
+ * Returns: a newly allocated string containing the reformatted value.
+ **/
 char *
 g_mime_header_format_addrlist (GMimeHeader *header, GMimeFormatOptions *options, const char *value, const 
char *charset)
 {
@@ -724,7 +784,18 @@ struct _received_part {
 };
 
 
-
+/**
+ * g_mime_header_format_received:
+ * @header: a #GMimeHeader
+ * @options: a #GMimeFormatOptions
+ * @value: a Received header value
+ * @charset: a charset (note: unused)
+ *
+ * Parses the @value and then re-formats it to conform to the formatting options,
+ * folding the value if necessary.
+ *
+ * Returns: a newly allocated string containing the reformatted value.
+ **/
 char *
 g_mime_header_format_received (GMimeHeader *header, GMimeFormatOptions *options, const char *value, const 
char *charset)
 {
@@ -843,6 +914,18 @@ g_mime_header_format_received (GMimeHeader *header, GMimeFormatOptions *options,
 }
 
 
+/**
+ * g_mime_header_format_default:
+ * @header: a #GMimeHeader
+ * @options: a #GMimeFormatOptions
+ * @value: a header value
+ * @charset: a charset to use when encoding the @value
+ *
+ * Parses the @value and then re-formats it to conform to the formatting options,
+ * folding the value if necessary.
+ *
+ * Returns: a newly allocated string containing the reformatted value.
+ **/
 char *
 g_mime_header_format_default (GMimeHeader *header, GMimeFormatOptions *options, const char *value, const 
char *charset)
 {
diff --git a/gmime/gmime-references.c b/gmime/gmime-references.c
index 0d583c6..5ab155c 100644
--- a/gmime/gmime-references.c
+++ b/gmime/gmime-references.c
@@ -212,7 +212,7 @@ g_mime_references_clear (GMimeReferences *refs)
 
 /**
  * g_mime_references_get_message_id:
- * @ref: a #GMimeReferences
+ * @refs: a #GMimeReferences
  * @index: the index of the message id
  *
  * Gets the specified Message-Id reference from the #GMimeReferences.
@@ -232,7 +232,7 @@ g_mime_references_get_message_id (GMimeReferences *refs, int index)
 
 /**
  * g_mime_references_set_message_id:
- * @ref: a #GMimeReferences
+ * @refs: a #GMimeReferences
  * @index: the index of the message id
  * @msgid: the message id
  *