GNOME.org
 

[gmime: 18/21] Updated docs

commit 7736276b5953f36b6985fc34598442c4c8913f3e
Author: Jeffrey Stedfast <fejj gnome org>
Date:   Sun Mar 26 14:05:02 2017 -0400

    Updated docs

 configure.ac                      |    2 +-
 docs/reference/Makefile.am        |    2 +-
 docs/reference/changes-3.0.sgml   |    7 ++++---
 docs/reference/gmime-sections.txt |   12 +++++++++---
 gmime/gmime-crypto-context.c      |    9 +++------
 gmime/gmime-filter-smtp-data.c    |    2 +-
 gmime/gmime-signature.h           |    3 ++-
 7 files changed, 21 insertions(+), 16 deletions(-)
---
diff --git a/configure.ac b/configure.ac
index 1300bb7..073833f 100644
--- a/configure.ac
+++ b/configure.ac
@@ -586,7 +586,7 @@ AS_IF([ test "x$enable_coverage" = "xyes"], [
     AC_MSG_ERROR([ccache must be disabled when --enable-coverage option is used. You can disable ccache by 
setting environment variable CCACHE_DISABLE=1.])
   fi
 
-  ltp_version_list="1.6 1.7 1.8 1.9 1.10"
+  ltp_version_list="1.6 1.7 1.8 1.9 1.10 1.11 1.12 1.13"
   AC_CHECK_PROG(LTP, lcov, lcov)
   AC_CHECK_PROG(LTP_GENHTML, genhtml, genhtml)
 
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 0e8b18a..e7ad20e 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -19,7 +19,7 @@ HTML_IMAGES =
 SCAN_OPTIONS = --deprecated-guards="GMIME_DISABLE_DEPRECATED"
 
 # Extra options to pass to gtkdoc-scangobj
-SCANGOBJ_OPTIONS=--type-init-func="g_mime_init (0)"
+SCANGOBJ_OPTIONS=--type-init-func="g_mime_init ()"
 
 # Extra options to supply to gtkdoc-mkdb
 MKDB_OPTIONS = --sgml-mode --output-format=xml --ignore-files=trio
diff --git a/docs/reference/changes-3.0.sgml b/docs/reference/changes-3.0.sgml
index ba1015d..24a53b1 100644
--- a/docs/reference/changes-3.0.sgml
+++ b/docs/reference/changes-3.0.sgml
@@ -19,7 +19,7 @@
       <listitem><para><function>g_mime_message_get_recipients()</function> has been replaced by 
<function>g_mime_message_get_addresses()</function> which allows you to access the address lists of any 
address header.</para></listitem>
       <listitem><para><function>g_mime_message_add_recipient()</function> has been renamed to 
<function>g_mime_message_add_mailbox()</function> due to the fact that it can now be used to add mailbox 
addresses to the Sender, From, and Reply-To headers as well.</para></listitem>
       <listitem><para><function>g_mime_message_set_subject()</function> now takes a charset argument used 
when encoding the subject into rfc2047 encoded-word tokens (if needed). Use NULL to get the old behavior of 
using a best-fit charset.</para></listitem>
-      <listitem><para>Removed <function>g_mime_message_get_date_as_string()</para> and 
<function>g_mime_message_get_date_as_string()</function>. This is unnecessary since this can be done using 
<function>g_mime_object_get_header()</function> and <function>g_mime_object_set_header()</function>.
+      <listitem><para>Removed <function>g_mime_message_get_date_as_string()</function> and 
<function>g_mime_message_get_date_as_string()</function>. This is unnecessary since this can be done using 
<function>g_mime_object_get_header()</function> and 
<function>g_mime_object_set_header()</function></para></listitem>.
     </itemizedlist>
     <para>Cryptography related API changes:</para>
     <itemizedlist>
@@ -30,7 +30,7 @@
       <listitem><para>Removed <function>g_mime_crypto_context_get_retrieve_session_key()</function> and 
<function>g_mime_crypto_context_set_retrieve_session_key()</function>. This is now handled by passing 
GMIME_DECRYPT_EXPORT_SESSION_KEY to the <function>g_mime_crypto_context_decrypt()</function> 
method.</para></listitem>
       <listitem><para>GMimeCryptoContext's encrypt, decrypt, and verify methods now all take a flags 
argument that can enable additional features (see above examples).</para></listitem>
       <listitem><para><function>g_mime_crypto_context_sign()</function> now takes a boolean 'detach' 
argument that specifies whether or not to generate a detached signature. To get the old behavior, pass TRUE 
as the detach argument.</para></listitem>
-      <listitem><para><function>g_mime_crypto_context_decrypt_session()<function> has been merged with 
<function>g_mime_crypto_context_decrypt()</function> and so the decryot method now takes a session_key 
argument that is allowed to be NULL.</para></listitem>
+      <listitem><para><function>g_mime_crypto_context_decrypt_session()</function> has been merged with 
<function>g_mime_crypto_context_decrypt()</function> and so the decryot method now takes a session_key 
argument that is allowed to be NULL.</para></listitem>
       <listitem><para><function>g_mime_crypto_context_verify()</function> no longer takes a 'digest' 
argument as it was unused (it was originally meant to be a hint but wasnever really needed).</para></listitem>
       <listitem><para><function>g_mime_multipart_signed_verify()</function> and 
<function>g_mime_multipart_encrypted_decrypt()</function> no longer take GMimeCryptoContext arguments. 
Instead, they instantiate their own contexts based on the protocol specified in the Content-Type header. 
These methods now also take a flags argument and in the case of the decrypt() method, it now also takes a 
session_key argument.</para></listitem>
       <listitem><para>GMimeSignatureStatus and GMimeSignatureErrors have been merged into a single bitfield 
(GMimeSignatureStatus) which mirrors gpgme_sigsum_t and thus 
<function>g_mime_signature_get_errors()</function> and <function>g_mime_signature_set_errors()</function> 
have been removed.</para></listitem>
@@ -38,6 +38,7 @@
       <listitem><para><function>g_mime_multipart_signed_sign()</function> no longer takes a 
GMimeMultipartSigned argument nor does it return int. Instead, this function now returns a newly allocated 
GMimeMultipartSigned.</para></listitem>
     </itemizedlist>
     <para>Other API changes:</para>
+    <itemizedlist>
       <listitem><para><function>g_mime_set_user_charsets()</function> and 
<function>g_mime_user_charsets()</function> have been removed. All encoding API's now have a way to specify a 
charset to use and all decoder API's take a GMimeParserOptions argument that allows for specifying fallback 
charsets.</para></listitem>
       <listitem><para>GMimeObject's prepend_header(), append_header(), set_header(), get_header(), and 
remove_header() virtual methods have all been removed. They have been replaced by the header_added(), 
header_changed(), header_removed(), and headers_cleared() virtual methods to allow users to set headers on 
the GMimeHeaderList directly and still get notifications of those changes.</para></listitem>
       <listitem><para><function>g_mime_object_new()</function> and 
<function>g_mime_object_new_with_type()</function> both now take a GMimeParserOptions 
argument.</para></listitem>
@@ -45,7 +46,7 @@
       <listitem><para><function>g_mime_content_type_new_from_string()</function> has been replaced by 
<function>g_mime_content_type_parse()</function> and now takes a GMimeParserOptions 
argument.</para></listitem>
       <listitem><para><function>g_mime_content_type_to_string()</function> has been renamed to 
<function>g_mime_content_type_get_mime_type()</function> and a new function has been introduced called 
<function>g_mime_content_type_encode()</function> that includes the encoded parameter list.</para></listitem>
       <listitem><para><function>g_mime_content_type_get_params()</function> has been renamed to 
<function>g_mime_content_type_get_parameters()</function>.</para></listitem>
-      <listitem><para><function>g_mime_content_disposition_new_from_string()<function> has been replaced by 
<function>g_mime_content_disposition_parse()</function> and now takes a GMimeParserOptions 
argument.</para></listitem>
+      <listitem><para><function>g_mime_content_disposition_new_from_string()</function> has been replaced by 
<function>g_mime_content_disposition_parse()</function> and now takes a GMimeParserOptions 
argument.</para></listitem>
       <listitem><para><function>g_mime_content_disposition_to_string()</function> has been replaced by 
<function>g_mime_content_disposition_encode()</function>.</para></listitem>
       <listitem><para><function>g_mime_content_disposition_get_params()</function> has been renamed to 
<function>g_mime_content_disposition_get_parameters()</function>.</para></listitem>
       <listitem><para><function>internet_address_list_parse_string()</function> has been replaced by 
<function>internet_address_list_parse()</function> and now takes a GMimeParserOptions 
argument.</para></listitem>
diff --git a/docs/reference/gmime-sections.txt b/docs/reference/gmime-sections.txt
index 5dd3505..3bd6a19 100644
--- a/docs/reference/gmime-sections.txt
+++ b/docs/reference/gmime-sections.txt
@@ -658,12 +658,20 @@ GMimeParamListClass
 GMimeHeader
 GMimeHeaderList
 GMimeHeaderRawValueFormatter
+g_mime_header_format_addrlist
+g_mime_header_format_content_disposition
+g_mime_header_format_content_type
+g_mime_header_format_default
+g_mime_header_format_message_id
+g_mime_header_format_received
+g_mime_header_format_references
 g_mime_header_get_name
 g_mime_header_get_raw_name
 g_mime_header_get_offset
 g_mime_header_get_value
 g_mime_header_set_value
 g_mime_header_get_raw_value
+g_mime_header_set_raw_value
 g_mime_header_write_to_stream
 g_mime_header_list_new
 g_mime_header_list_get_count
@@ -1214,7 +1222,7 @@ internet_address_list_set_address
 internet_address_list_prepend
 internet_address_list_append
 internet_address_list_to_string
-internet_address_list_writer
+internet_address_list_encode
 
 <SUBSECTION Private>
 internet_address_list_get_type
@@ -1324,8 +1332,6 @@ g_mime_charset_can_encode
 
 <SECTION>
 <FILE>gmime-iconv</FILE>
-g_mime_iconv_init
-g_mime_iconv_shutdown
 g_mime_iconv_open
 g_mime_iconv
 g_mime_iconv_close
diff --git a/gmime/gmime-crypto-context.c b/gmime/gmime-crypto-context.c
index 0672e0a..ee850eb 100644
--- a/gmime/gmime-crypto-context.c
+++ b/gmime/gmime-crypto-context.c
@@ -830,7 +830,7 @@ g_mime_decrypt_result_get_mdc (GMimeDecryptResult *result)
  * @result: a #GMimeDecryptResult
  * @session_key: a pointer to a null-terminated string representing the session key
  *
- * Set the session_key to be returned by this decryption result.
+ * Set the session key to be returned by this decryption result.
  **/
 void
 g_mime_decrypt_result_set_session_key (GMimeDecryptResult *result, const char *session_key)
@@ -850,12 +850,9 @@ g_mime_decrypt_result_set_session_key (GMimeDecryptResult *result, const char *s
  * g_mime_decrypt_result_get_session_key:
  * @result: a #GMimeDecryptResult
  *
- * Get the session_key used for this decryption, if the underlying
- * crypto context is capable of and (configured to) retrieve session
- * keys during decryption.  See, for example,
- * g_mime_crypto_context_set_retrieve_session_key().
+ * Get the session_key used for this decryption.
  *
- * Returns: the session_key digest algorithm used, or NULL if no
+ * Returns: the session key digest algorithm used, or %NULL if no
  * session key was requested or found.
  **/
 const char *
diff --git a/gmime/gmime-filter-smtp-data.c b/gmime/gmime-filter-smtp-data.c
index 6900d58..bb8dc15 100644
--- a/gmime/gmime-filter-smtp-data.c
+++ b/gmime/gmime-filter-smtp-data.c
@@ -27,7 +27,7 @@
 
 
 /**
- * SECTION: gmime-filter-smtp_data
+ * SECTION: gmime-filter-smtp-data
  * @title: GMimeFilterSmtpData
  * @short_description: Byte-stuffs outgoing SMTP DATA.
  *
diff --git a/gmime/gmime-signature.h b/gmime/gmime-signature.h
index 2ea8bdf..7350315 100644
--- a/gmime/gmime-signature.h
+++ b/gmime/gmime-signature.h
@@ -135,12 +135,13 @@ time_t g_mime_signature_get_expires (GMimeSignature *sig);
 /**
  * GMimeSignatureList:
  * @parent_object: parent #GObject
- * @array: An array of #GMimeSignature objects.
  *
  * A collection of #GMimeSignature objects.
  **/
 struct _GMimeSignatureList {
        GObject parent_object;
+       
+       /* < private > */
        GPtrArray *array;
 };
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]