[gmime: 5/6] Updated docs

[Jeffrey Stedfast <fejj src gnome org>]

commit dfadf1d2638399d552d597bc30a47e0ed3bfe0db
Author: Jeffrey Stedfast <jestedfa microsoft com>
Date:   Thu Mar 30 11:46:36 2017 -0400

    Updated docs

 docs/reference/gmime-sections.txt |   21 +++++++++++++++++++++
 gmime/gmime-part-iter.c           |   29 +++++++++++++++++++++++++++++
 gmime/gmime-part-iter.h           |    6 ++++++
 3 files changed, 56 insertions(+), 0 deletions(-)
---
diff --git a/docs/reference/gmime-sections.txt b/docs/reference/gmime-sections.txt
index e438ad8..f847a8e 100644
--- a/docs/reference/gmime-sections.txt
+++ b/docs/reference/gmime-sections.txt
@@ -856,6 +856,7 @@ GMimePartClass
 GMimePartIter
 g_mime_part_iter_new
 g_mime_part_iter_free
+g_mime_part_iter_clone
 g_mime_part_iter_reset
 g_mime_part_iter_jump_to
 g_mime_part_iter_is_valid
@@ -867,6 +868,12 @@ g_mime_part_iter_get_parent
 g_mime_part_iter_get_path
 g_mime_part_iter_replace
 g_mime_part_iter_remove
+
+<SUBSECTION Private>
+g_mime_part_iter_get_type
+
+<SUBSECTION Standard>
+GMIME_TYPE_PART_ITER
 </SECTION>
 
 <SECTION>
@@ -1250,6 +1257,7 @@ GMimeNewLineFormat
 GMimeFormatOptions
 g_mime_format_options_new
 g_mime_format_options_free
+g_mime_format_options_clone
 g_mime_format_options_get_default
 g_mime_format_options_get_param_encoding_method
 g_mime_format_options_set_param_encoding_method
@@ -1261,6 +1269,12 @@ g_mime_format_options_is_hidden_header
 g_mime_format_options_add_hidden_header
 g_mime_format_options_remove_hidden_header
 g_mime_format_options_clear_hidden_headers
+
+<SUBSECTION Private>
+g_mime_format_options_get_type
+
+<SUBSECTION Standard>
+GMIME_TYPE_FORMAT_OPTIONS
 </SECTION>
 
 <SECTION>
@@ -1269,6 +1283,7 @@ GMimeParserOptions
 GMimeRfcComplianceMode
 g_mime_parser_options_new
 g_mime_parser_options_free
+g_mime_parser_options_clone
 g_mime_parser_options_get_default
 g_mime_parser_options_get_address_compliance_mode
 g_mime_parser_options_set_address_compliance_mode
@@ -1278,6 +1293,12 @@ 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
+
+<SUBSECTION Private>
+g_mime_parser_options_get_type
+
+<SUBSECTION Standard>
+GMIME_TYPE_PARSER_OPTIONS
 </SECTION>
 
 <SECTION>
diff --git a/gmime/gmime-part-iter.c b/gmime/gmime-part-iter.c
index fdf568c..1410bb4 100644
--- a/gmime/gmime-part-iter.c
+++ b/gmime/gmime-part-iter.c
@@ -44,6 +44,9 @@
  **/
 
 
+G_DEFINE_BOXED_TYPE (GMimePartIter, g_mime_part_iter, g_mime_part_iter_clone, g_mime_part_iter_free);
+
+
 typedef struct _GMimeObjectStack GMimeObjectStack;
 
 struct _GMimeObjectStack {
@@ -147,6 +150,32 @@ g_mime_part_iter_free (GMimePartIter *iter)
 
 
 /**
+ * g_mime_part_iter_clone:
+ * @iter: a #GMimePartIter
+ *
+ * Clones the @iter, including its current state.
+ *
+ * Returns: (transfer full): a new #GMimePartIter that is identical to @iter.
+ **/
+GMimePartIter *
+g_mime_part_iter_clone (GMimePartIter *iter)
+{
+       GMimePartIter *clone;
+       char *path;
+       
+       g_return_val_if_fail (iter != NULL, NULL);
+       
+       clone = g_mime_part_iter_new (iter->toplevel);
+       if ((path = g_mime_part_iter_get_path (iter))) {
+               g_mime_part_iter_jump_to (clone, path);
+               g_free (path);
+       }
+       
+       return clone;
+}
+
+
+/**
  * g_mime_part_iter_reset:
  * @iter: a #GMimePartIter
  *
diff --git a/gmime/gmime-part-iter.h b/gmime/gmime-part-iter.h
index 1e95835..a2c2013 100644
--- a/gmime/gmime-part-iter.h
+++ b/gmime/gmime-part-iter.h
@@ -26,6 +26,8 @@
 
 G_BEGIN_DECLS
 
+#define GMIME_TYPE_PART_ITER (g_mime_part_iter_get_type ())
+
 /**
  * GMimePartIter:
  *
@@ -33,9 +35,13 @@ G_BEGIN_DECLS
  **/
 typedef struct _GMimePartIter GMimePartIter;
 
+GType g_mime_part_iter_get_type (void) G_GNUC_CONST;
+
 GMimePartIter *g_mime_part_iter_new (GMimeObject *toplevel);
 void g_mime_part_iter_free (GMimePartIter *iter);
 
+GMimePartIter *g_mime_part_iter_clone (GMimePartIter *iter);
+
 void g_mime_part_iter_reset (GMimePartIter *iter);
 
 gboolean g_mime_part_iter_jump_to (GMimePartIter *iter, const char *path);