[gmime] Improved documentation



commit 458d521e3f99d44217c6c8e029d5ca9dc04d31c9
Author: Jeffrey Stedfast <jestedfa microsoft com>
Date:   Sun May 21 12:12:20 2017 -0400

    Improved documentation

 PORTING                         |    2 ++
 docs/reference/changes-3.0.sgml |    1 +
 gmime/gmime-signature.c         |    2 +-
 gmime/gmime-signature.h         |    2 +-
 4 files changed, 5 insertions(+), 2 deletions(-)
---
diff --git a/PORTING b/PORTING
index 20935e9..80de6d9 100644
--- a/PORTING
+++ b/PORTING
@@ -157,6 +157,8 @@ Porting from GMime 2.6 to GMime 3.0
 
 - Modified g_mime_object_write_to_stream() to take a GMimeFormatOptions argument.
 
+- Split GMimeFilterCRLF into GMimeFilterUnix2Dos, GMimeFilterDos2Unix and GMimeFilterSmtpData.
+
 
 Porting from GMime 2.4 to GMime 2.6
 -----------------------------------
diff --git a/docs/reference/changes-3.0.sgml b/docs/reference/changes-3.0.sgml
index c02aab0..7c4b91c 100644
--- a/docs/reference/changes-3.0.sgml
+++ b/docs/reference/changes-3.0.sgml
@@ -65,6 +65,7 @@
       <listitem><para>Renamed <function>g_mime_multipart_get_preface()</function> to 
<function>g_mime_multipart_get_prologue()</function> and <function>g_mime_multipart_set_preface</function> to 
<function>g_mime_multipart_set_prologue</function>.</para></listitem>
       <listitem><para>Renamed <function>g_mime_multipart_get_postface()</function> to 
<function>g_mime_multipart_get_epilogue()</function> and <function>g_mime_multipart_set_postface()</function> 
to <function>g_mime_multipart_set_epilogue()</function>.</para></listitem>
       <listitem><para>Updated <function>g_mime_object_write_to_stream()</function> to take a 
GMimeFormatOptions argument.</para></listitem>
+      <listitem><para>Split GMimeFilterCRLF into GMimeFilterDos2Unix, GMimeFilterUnix2Dos and 
GMimeFilterSmtpData.</para></listitem>
     </itemizedlist>
   </refsect1>
 </refentry>
diff --git a/gmime/gmime-signature.c b/gmime/gmime-signature.c
index f83c2b9..7b3fa55 100644
--- a/gmime/gmime-signature.c
+++ b/gmime/gmime-signature.c
@@ -135,7 +135,7 @@ g_mime_signature_set_status (GMimeSignature *sig, GMimeSignatureStatus status)
  * g_mime_signature_get_status:
  * @sig: a #GMimeSignature
  *
- * Get the signature status.
+ * Get the signature status as a bitfield of #GMimeSignatureStatus flags.
  *
  * Returns: the signature status.
  **/
diff --git a/gmime/gmime-signature.h b/gmime/gmime-signature.h
index 7350315..731b3cd 100644
--- a/gmime/gmime-signature.h
+++ b/gmime/gmime-signature.h
@@ -63,7 +63,7 @@ typedef struct _GMimeSignatureListClass GMimeSignatureListClass;
  * @GMIME_SIGNATURE_STATUS_SYS_ERROR: A system error occurred.
  * @GMIME_SIGNATURE_STATUS_TOFU_CONFLICT: Tofu conflict detected.
  *
- * A value representing the signature status flags for a particular
+ * A value representing the signature status bit flags for a particular
  * #GMimeSignature.
  **/
 typedef enum {


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