[gmime: 2/6] updated docs

From: Jeffrey Stedfast <fejj src gnome org>
To: commits-list gnome org
Cc:
Subject: [gmime: 2/6] updated docs
Date: Thu, 30 Mar 2017 15:48:03 +0000 (UTC)
commit ec4fc57e94410605ee58eabdc3b8b06d8b1ccf22
Author: Jeffrey Stedfast <fejj gnome org>
Date:   Thu Mar 30 09:45:51 2017 -0400

    updated docs

 gmime/gmime-content-type.c |    4 ++--
 gmime/gmime-disposition.c  |    6 +++---
 gmime/gmime-header.c       |   26 +++++++++++++-------------
 gmime/gmime-param.c        |    4 ++--
 gmime/gmime-references.c   |    3 ++-
 gmime/gmime-references.h   |    5 ++++-
 gmime/gmime-utils.c        |   34 +++++++++++++++++-----------------
 7 files changed, 43 insertions(+), 39 deletions(-)
---
diff --git a/gmime/gmime-content-type.c b/gmime/gmime-content-type.c
index 07dc181..b0516ab 100644
--- a/gmime/gmime-content-type.c
+++ b/gmime/gmime-content-type.c
@@ -177,7 +177,7 @@ g_mime_content_type_new (const char *type, const char *subtype)
 
 /**
  * g_mime_content_type_parse:
- * @options: a #GMimeParserOptions
+ * @options: a #GMimeParserOptions or %NULL
  * @str: input string containing a content-type (and params)
  *
  * Parses the input string into a #GMimeContentType object.
@@ -244,7 +244,7 @@ g_mime_content_type_get_mime_type (GMimeContentType *content_type)
 /**
  * g_mime_content_type_encode:
  * @content_type: a #GMimeContentType
- * @options: a #GMimeFormatOptions
+ * @options: a #GMimeFormatOptions or %NULL
  *
  * Encodes the Content-Disposition header.
  *
diff --git a/gmime/gmime-disposition.c b/gmime/gmime-disposition.c
index 77070cb..ac76de1 100644
--- a/gmime/gmime-disposition.c
+++ b/gmime/gmime-disposition.c
@@ -138,8 +138,8 @@ g_mime_content_disposition_new (void)
 
 /**
  * g_mime_content_disposition_parse:
- * @options: a #GMimeParserOptions
- * @str: Content-Disposition field value or %NULL
+ * @options: a #GMimeParserOptions or %NULL
+ * @str: Content-Disposition field value
  *
  * Parses the input string into a #GMimeContentDisposition object.
  *
@@ -306,7 +306,7 @@ g_mime_content_disposition_is_attachment (GMimeContentDisposition *disposition)
 /**
  * g_mime_content_disposition_encode:
  * @disposition: a #GMimeContentDisposition object
- * @options: a #GMimeFormatOptions
+ * @options: a #GMimeFormatOptions or %NULL
  *
  * Encodes the Content-Disposition header.
  *
diff --git a/gmime/gmime-header.c b/gmime/gmime-header.c
index ce1c16d..0952e3e 100644
--- a/gmime/gmime-header.c
+++ b/gmime/gmime-header.c
@@ -149,7 +149,7 @@ g_mime_header_finalize (GObject *object)
 
 /**
  * g_mime_header_new:
- * @options: a #GMimeParserOptions
+ * @options: a #GMimeParserOptions or %NULL
  * @name: header name
  * @value: header value
  * @raw_value: raw header value
@@ -271,7 +271,7 @@ g_mime_header_get_value (GMimeHeader *header)
 /**
  * g_mime_header_set_value:
  * @header: a #GMimeHeader
- * @options: a #GMimeFormatOptions
+ * @options: a #GMimeFormatOptions or %NULL
  * @value: the new header value
  * @charset: a charset
  *
@@ -402,7 +402,7 @@ _g_mime_header_set_offset (GMimeHeader *header, gint64 offset)
 /**
  * g_mime_header_write_to_stream:
  * @header: a #GMimeHeader
- * @options: a #GMimeFormatOptions
+ * @options: a #GMimeFormatOptions or %NULL
  * @stream: a #GMimeStream
  *
  * Write the header to the specified stream.
@@ -437,7 +437,7 @@ g_mime_header_write_to_stream (GMimeHeader *header, GMimeFormatOptions *options,
 /**
  * g_mime_header_format_content_disposition:
  * @header: a #GMimeHeader
- * @options: a #GMimeFormatOptions
+ * @options: a #GMimeFormatOptions or %NULL
  * @value: a Content-Disposition header value
  * @charset: a charset (note: unused)
  *
@@ -474,7 +474,7 @@ g_mime_header_format_content_disposition (GMimeHeader *header, GMimeFormatOption
 /**
  * g_mime_header_format_content_type:
  * @header: a #GMimeHeader
- * @options: a #GMimeFormatOptions
+ * @options: a #GMimeFormatOptions or %NULL
  * @value: a Content-Type header value
  * @charset: a charset (note: unused)
  *
@@ -513,7 +513,7 @@ g_mime_header_format_content_type (GMimeHeader *header, GMimeFormatOptions *opti
 /**
  * g_mime_header_format_message_id:
  * @header: a #GMimeHeader
- * @options: a #GMimeFormatOptions
+ * @options: a #GMimeFormatOptions or %NULL
  * @value: a Message-Id or Content-Id header value
  * @charset: a charset (note: unused)
  *
@@ -534,7 +534,7 @@ g_mime_header_format_message_id (GMimeHeader *header, GMimeFormatOptions *option
 /**
  * g_mime_header_format_references:
  * @header: a #GMimeHeader
- * @options: a #GMimeFormatOptions
+ * @options: a #GMimeFormatOptions or %NULL
  * @value: a References or In-Reply-To header value
  * @charset: a charset (note: unused)
  *
@@ -592,7 +592,7 @@ g_mime_header_format_references (GMimeHeader *header, GMimeFormatOptions *option
 /**
  * g_mime_header_format_addrlist:
  * @header: a #GMimeHeader
- * @options: a #GMimeFormatOptions
+ * @options: a #GMimeFormatOptions or %NULL
  * @value: a Sender, From, Reply-To, To, Cc, or Bcc header value
  * @charset: a charset (note: unused)
  *
@@ -787,7 +787,7 @@ struct _received_part {
 /**
  * g_mime_header_format_received:
  * @header: a #GMimeHeader
- * @options: a #GMimeFormatOptions
+ * @options: a #GMimeFormatOptions or %NULL
  * @value: a Received header value
  * @charset: a charset (note: unused)
  *
@@ -917,7 +917,7 @@ g_mime_header_format_received (GMimeHeader *header, GMimeFormatOptions *options,
 /**
  * g_mime_header_format_default:
  * @header: a #GMimeHeader
- * @options: a #GMimeFormatOptions
+ * @options: a #GMimeFormatOptions or %NULL
  * @value: a header value
  * @charset: a charset to use when encoding the @value
  *
@@ -1028,7 +1028,7 @@ g_mime_header_list_finalize (GObject *object)
 
 /**
  * g_mime_header_list_new:
- * @options: a #GMimeParserOptions
+ * @options: a #GMimeParserOptions or %NULL
  *
  * Creates a new #GMimeHeaderList object.
  *
@@ -1475,7 +1475,7 @@ g_mime_header_list_remove_at (GMimeHeaderList *headers, int index)
 /**
  * g_mime_header_list_write_to_stream:
  * @headers: a #GMimeHeaderList
- * @options: a #GMimeFormatOptions
+ * @options: a #GMimeFormatOptions or %NULL
  * @stream: output stream
  *
  * Write the headers to a stream.
@@ -1520,7 +1520,7 @@ g_mime_header_list_write_to_stream (GMimeHeaderList *headers, GMimeFormatOptions
 /**
  * g_mime_header_list_to_string:
  * @headers: a #GMimeHeaderList
- * @options: a #GMimeFormatOptions
+ * @options: a #GMimeFormatOptions or %NULL
  *
  * Allocates a string buffer containing the raw rfc822 headers
  * contained in @headers.
diff --git a/gmime/gmime-param.c b/gmime/gmime-param.c
index 9ff02a5..29db3de 100644
--- a/gmime/gmime-param.c
+++ b/gmime/gmime-param.c
@@ -718,7 +718,7 @@ g_string_append_len_quoted (GString *str, const char *text, size_t len)
 /**
  * g_mime_param_list_encode:
  * @list: a #GMimeParamList
- * @options: a #GMimeFormatOptions
+ * @options: a #GMimeFormatOptions or %NULL
  * @fold: %TRUE if the parameter list should be folded; otherwise, %FALSE
  * @str: the output string buffer
  *
@@ -1422,7 +1422,7 @@ decode_param_list (GMimeParserOptions *options, const char *in)
 
 /**
  * g_mime_param_list_parse:
- * @options: a #GMimeParserOptions
+ * @options: a #GMimeParserOptions or %NULL
  * @str: a string to parse
  *
  * Parses the input string into a parameter list.
diff --git a/gmime/gmime-references.c b/gmime/gmime-references.c
index 5ab155c..71a5346 100644
--- a/gmime/gmime-references.c
+++ b/gmime/gmime-references.c
@@ -89,6 +89,7 @@ g_mime_references_free (GMimeReferences *refs)
 
 /**
  * g_mime_references_parse:
+ * @options: a #GMimeParserOptions or %NULL
  * @text: string containing a list of msg-ids
  *
  * Decodes a list of msg-ids as in the References and/or In-Reply-To
@@ -97,7 +98,7 @@ g_mime_references_free (GMimeReferences *refs)
  * Returns: a new #GMimeReferences containing the parsed message ids.
  **/
 GMimeReferences *
-g_mime_references_parse (const char *text)
+g_mime_references_parse (GMimeParserOptions *options, const char *text)
 {
        const char *word, *inptr = text;
        GMimeReferences *refs;
diff --git a/gmime/gmime-references.h b/gmime/gmime-references.h
index 34c9383..7bb3a8e 100644
--- a/gmime/gmime-references.h
+++ b/gmime/gmime-references.h
@@ -25,6 +25,9 @@
 #include <glib.h>
 #include <glib-object.h>
 
+#include <gmime/gmime-parser-options.h>
+
+
 G_BEGIN_DECLS
 
 #define GMIME_TYPE_REFERENCES (gmime_references_get_type ())
@@ -48,7 +51,7 @@ GType g_mime_references_get_type (void) G_GNUC_CONST;
 GMimeReferences *g_mime_references_new (void);
 void g_mime_references_free (GMimeReferences *refs);
 
-GMimeReferences *g_mime_references_parse (const char *text);
+GMimeReferences *g_mime_references_parse (GMimeParserOptions *options, const char *text);
 
 GMimeReferences *g_mime_references_copy (GMimeReferences *refs);
 
diff --git a/gmime/gmime-utils.c b/gmime/gmime-utils.c
index 6e53575..792eef7 100644
--- a/gmime/gmime-utils.c
+++ b/gmime/gmime-utils.c
@@ -1150,7 +1150,7 @@ charset_convert (iconv_t cd, const char *inbuf, size_t inleft, char **outp, size
 
 /**
  * g_mime_utils_decode_8bit:
- * @options: a #GMimeParserOptions
+ * @options: a #GMimeParserOptions or %NULL
  * @text: (array length=len) (element-type guint8): input text in
  *   unknown 8bit/multibyte character set
  * @len: input text length
@@ -1860,7 +1860,7 @@ rfc2047_decode_tokens (GMimeParserOptions *options, rfc2047_token *tokens, size_
 /**
  * _g_mime_utils_header_decode_text:
  * @text: header text to decode
- * @options: a #GMimeParserOptions
+ * @options: a #GMimeParserOptions or %NULL
  * @charset: if non-%NULL, this will be set to the charset used in the rfc2047 encoded-word tokens
  *
  * Decodes an rfc2047 encoded 'text' header.
@@ -1893,7 +1893,7 @@ _g_mime_utils_header_decode_text (GMimeParserOptions *options, const char *text,
 /**
  * g_mime_utils_header_decode_text:
  * @text: header text to decode
- * @options: a #GMimeParserOptions
+ * @options: a #GMimeParserOptions or %NULL
  *
  * Decodes an rfc2047 encoded 'text' header.
  *
@@ -1910,7 +1910,7 @@ g_mime_utils_header_decode_text (GMimeParserOptions *options, const char *text)
 /**
  * _g_mime_utils_header_decode_phrase:
  * @phrase: header to decode
- * @options: a #GMimeParserOptions
+ * @options: a #GMimeParserOptions or %NULL
  * @charset: if non-%NULL, this will be set to the charset used in the rfc2047 encoded-word tokens
  *
  * Decodes an rfc2047 encoded 'phrase' header.
@@ -1943,7 +1943,7 @@ _g_mime_utils_header_decode_phrase (GMimeParserOptions *options, const char *phr
 /**
  * g_mime_utils_header_decode_phrase:
  * @phrase: header to decode
- * @options: a #GMimeParserOptions
+ * @options: a #GMimeParserOptions or %NULL
  *
  * Decodes an rfc2047 encoded 'phrase' header.
  *
@@ -2401,7 +2401,7 @@ rfc2047_encode (GMimeFormatOptions *options, const char *in, gushort safemask, c
 
 /**
  * g_mime_utils_header_encode_phrase:
- * @options: a #GMimeFormatOptions
+ * @options: a #GMimeFormatOptions or %NULL
  * @phrase: phrase to encode
  * @charset: the charset to use or %NULL to use the default
  *
@@ -2422,7 +2422,7 @@ g_mime_utils_header_encode_phrase (GMimeFormatOptions *options, const char *phra
 
 /**
  * g_mime_utils_header_encode_text:
- * @options: a #GMimeFormatOptions
+ * @options: a #GMimeFormatOptions or %NULL
  * @text: text to encode
  * @charset: the charset to use or %NULL to use the default
  *
@@ -2570,8 +2570,8 @@ header_fold_tokens (GMimeFormatOptions *options, const char *field, const char *
 
 /**
  * g_mime_utils_structured_header_fold:
- * @options: a #GMimeParserOptions
- * @format: a #GMimeFormatOptions
+ * @options: a #GMimeParserOptions or %NULL
+ * @format: a #GMimeFormatOptions or %NULL
  * @header: header field and value string
  *
  * Folds a structured header according to the rules in rfc822.
@@ -2613,8 +2613,8 @@ g_mime_utils_structured_header_fold (GMimeParserOptions *options, GMimeFormatOpt
 
 /**
  * _g_mime_utils_structured_header_fold:
- * @options: a #GMimeParserOptions
- * @format: a #GMimeFormatOptions
+ * @options: a #GMimeParserOptions or %NULL
+ * @format: a #GMimeFormatOptions or %NULL
  * @field: header field
  * @value: header value
  *
@@ -2643,8 +2643,8 @@ _g_mime_utils_structured_header_fold (GMimeParserOptions *options, GMimeFormatOp
 
 /**
  * g_mime_utils_unstructured_header_fold:
- * @options: a #GMimeParserOptions
- * @format: a #GMimeFormatOptions
+ * @options: a #GMimeParserOptions or %NULL
+ * @format: a #GMimeFormatOptions or %NULL
  * @header: header field and value string
  *
  * Folds an unstructured header according to the rules in rfc822.
@@ -2686,8 +2686,8 @@ g_mime_utils_unstructured_header_fold (GMimeParserOptions *options, GMimeFormatO
 
 /**
  * _g_mime_utils_unstructured_header_fold:
- * @options: a #GMimeParserOptions
- * @format: a #GMimeFormatOptions
+ * @options: a #GMimeParserOptions or %NULL
+ * @format: a #GMimeFormatOptions or %NULL
  * @field: header field
  * @value: header value
  *
@@ -2715,8 +2715,8 @@ _g_mime_utils_unstructured_header_fold (GMimeParserOptions *options, GMimeFormat
 
 /**
  * g_mime_utils_header_printf:
- * @options: a #GMimeParserOptions
- * @format: a #GMimeFormatOptions
+ * @options: a #GMimeParserOptions or %NULL
+ * @format: a #GMimeFormatOptions or %NULL
  * @text: text with printf-style formatters
  * @...: arguments
  *
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]