[gmime] Updated docs



commit e8e5ed3b745b23f56091a15239fdeb30f4ee8dc6
Author: Jeffrey Stedfast <fejj gnome org>
Date:   Sat Mar 11 09:23:25 2017 -0500

    Updated docs

 docs/reference/Makefile.am        |    2 +-
 docs/reference/gmime-sections.txt |   32 ++++++++++++++++++++++++++++++--
 gmime/gmime-certificate.h         |    2 +-
 gmime/gmime-filter-html.h         |    2 +-
 gmime/gmime-parser-options.c      |   13 ++++++++++++-
 gmime/gmime-parser.c              |    2 +-
 gmime/gmime-text-part.c           |    1 -
 gmime/gmime-utils.c               |    1 +
 8 files changed, 47 insertions(+), 8 deletions(-)
---
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 683a36e..8edbd4f 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -58,10 +58,10 @@ CFILE_GLOB=$(top_srcdir)/gmime/*.c
 
 # Header files to ignore when scanning
 IGNORE_HFILES =                        \
-       gmime-application-pkcs7-mime.h  \
        gmime-charset-map-private.h     \
        gmime-table-private.h           \
        gmime-parse-utils.h             \
+       gmime-gpgme-utils.h             \
        gmime-common.h                  \
        gmime-events.h
 
diff --git a/docs/reference/gmime-sections.txt b/docs/reference/gmime-sections.txt
index 0da0102..a8af244 100644
--- a/docs/reference/gmime-sections.txt
+++ b/docs/reference/gmime-sections.txt
@@ -19,7 +19,12 @@ g_mime_check_version
 <SECTION>
 <FILE>gmime-error</FILE>
 GMIME_ERROR
+GMIME_GPGME_ERROR
 GMIME_ERROR_IS_SYSTEM
+
+<SUBSECTION Private>
+gmime_error_quark
+gmime_gpgme_error_quark
 </SECTION>
 
 <SECTION>
@@ -101,8 +106,8 @@ GMIME_STREAM_CAT_GET_CLASS
 <FILE>gmime-stream-file</FILE>
 GMimeStreamFile
 g_mime_stream_file_new
+g_mime_stream_file_open
 g_mime_stream_file_new_with_bounds
-g_mime_stream_file_new_for_path
 g_mime_stream_file_get_owner
 g_mime_stream_file_set_owner
 
@@ -123,8 +128,8 @@ GMIME_STREAM_FILE_GET_CLASS
 <FILE>gmime-stream-fs</FILE>
 GMimeStreamFs
 g_mime_stream_fs_new
+g_mime_stream_fs_open
 g_mime_stream_fs_new_with_bounds
-g_mime_stream_fs_new_for_path
 g_mime_stream_fs_get_owner
 g_mime_stream_fs_set_owner
 
@@ -991,6 +996,12 @@ g_mime_utils_header_decode_phrase
 g_mime_utils_header_encode_phrase
 g_mime_utils_structured_header_fold
 g_mime_utils_unstructured_header_fold
+
+<SUBSECTION Private>
+g_mime_references_get_type
+
+<SUBSECTION Standard>
+GMIME_TYPE_REFERENCES
 </SECTION>
 
 <SECTION>
@@ -1121,6 +1132,23 @@ InternetAddressListClass
 </SECTION>
 
 <SECTION>
+<FILE>gmime-parser-options</FILE>
+GMimeParserOptions
+GMimeRfcComplianceMode
+g_mime_parser_options_new
+g_mime_parser_options_free
+g_mime_parser_options_get_default
+g_mime_parser_options_get_address_parser_compliance_mode
+g_mime_parser_options_set_address_parser_compliance_mode
+g_mime_parser_options_get_parameter_compliance_mode
+g_mime_parser_options_set_parameter_compliance_mode
+g_mime_parser_options_get_rfc2047_compliance_mode
+g_mime_parser_options_set_rfc2047_compliance_mode
+g_mime_parser_options_get_fallback_charsets
+g_mime_parser_options_set_fallback_charsets
+</SECTION>
+
+<SECTION>
 <FILE>gmime-parser</FILE>
 GMimeParser
 GMimeParserHeaderRegexFunc
diff --git a/gmime/gmime-certificate.h b/gmime/gmime-certificate.h
index 2aa7de8..86afc24 100644
--- a/gmime/gmime-certificate.h
+++ b/gmime/gmime-certificate.h
@@ -101,7 +101,7 @@ typedef enum {
  * @GMIME_PUBKEY_ALGO_ELG: The ElGamal algorithm.
  * @GMIME_PUBKEY_ALGO_ECDSA: The Eliptic Curve + DSA algorithm.
  * @GMIME_PUBKEY_ALGO_ECDH: The Eliptic Curve + Diffie Helman algorithm.
- * @GMIME_PUBKEY_ALGO_ECDSA: The Eliptic Curve + DSA algorithm.
+ * @GMIME_PUBKEY_ALGO_EDDSA: The Eliptic Curve + DSA algorithm.
  *
  * A public-key algorithm.
  **/
diff --git a/gmime/gmime-filter-html.h b/gmime/gmime-filter-html.h
index c9cc3ee..2adea8b 100644
--- a/gmime/gmime-filter-html.h
+++ b/gmime/gmime-filter-html.h
@@ -103,7 +103,7 @@ typedef struct _GMimeFilterHTMLClass GMimeFilterHTMLClass;
 #define GMIME_FILTER_HTML_CITE                (1 << 7)
 
 /**
- * GMIME_FILTER_HTML_MARK_CITATION_BLOCKQUOTE:
+ * GMIME_FILTER_HTML_BLOCKQUOTE_CITATION:
  *
  * Enclose citation text in blockquotes.
  **/
diff --git a/gmime/gmime-parser-options.c b/gmime/gmime-parser-options.c
index 45222b4..4222654 100644
--- a/gmime/gmime-parser-options.c
+++ b/gmime/gmime-parser-options.c
@@ -32,6 +32,17 @@ static char *default_charsets[3] = { "utf-8", "iso-8859-1", NULL };
 static GMimeParserOptions *default_options = NULL;
 
 
+/**
+ * SECTION: gmime-parser-options
+ * @title: GMimeParserOptions
+ * @short_description: Parser options
+ * @see_also:
+ *
+ * A #GMimeParserOptions is used to pass various options to #GMimeParser
+ * and all of the various other parser functions in GMime.
+ **/
+
+
 void
 g_mime_parser_options_init (void)
 {
@@ -66,7 +77,7 @@ g_mime_parser_options_get_default (void)
 
 
 /**
- * @g_mime_parser_options_new:
+ * g_mime_parser_options_new:
  *
  * Creates a new set of #GMimeParserOptions.
  *
diff --git a/gmime/gmime-parser.c b/gmime/gmime-parser.c
index 3c63476..4b5d62e 100644
--- a/gmime/gmime-parser.c
+++ b/gmime/gmime-parser.c
@@ -1999,7 +1999,7 @@ g_mime_parser_construct_message (GMimeParser *parser)
 
 
 /**
- * g_mime_parser_construct_message:
+ * g_mime_parser_construct_message_with_options:
  * @parser: a #GMimeParser context
  *
  * Constructs a MIME message from @parser.
diff --git a/gmime/gmime-text-part.c b/gmime/gmime-text-part.c
index 644f42f..cb1243b 100644
--- a/gmime/gmime-text-part.c
+++ b/gmime/gmime-text-part.c
@@ -250,7 +250,6 @@ g_mime_text_part_set_text (GMimeTextPart *mime_part, const char *text)
 /**
  * g_mime_text_part_get_text:
  * @mime_part: a #GMimeTextPart
- * @charset: the charset
  *
  * Gets the text content of the @mime_part as a string.
  *
diff --git a/gmime/gmime-utils.c b/gmime/gmime-utils.c
index 1184688..1f085fc 100644
--- a/gmime/gmime-utils.c
+++ b/gmime/gmime-utils.c
@@ -1449,6 +1449,7 @@ charset_convert (iconv_t cd, const char *inbuf, size_t inleft, char **outp, size
 
 /**
  * g_mime_utils_decode_8bit:
+ * @options: a #GMimeParserOptions
  * @text: (array length=len) (element-type guint8): input text in
  *   unknown 8bit/multibyte character set
  * @len: input text length


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]