[gmime] Updated docs



commit 07173d624b4c9899c0da575d5fc2b9d7b1becc5e
Author: Jeffrey Stedfast <fejj gnome org>
Date:   Sat Mar 11 09:39:57 2017 -0500

    Updated docs

 docs/reference/gmime-sections.txt    |    2 ++
 gmime/gen-table.c                    |    4 ++--
 gmime/gmime-application-pkcs7-mime.h |    1 +
 gmime/gmime-filter.h                 |   26 ++++++++------------------
 gmime/gmime-message.h                |    2 --
 gmime/gmime-multipart.h              |    4 +++-
 gmime/gmime-parser.c                 |    1 +
 gmime/gmime-stream.h                 |    4 ----
 gmime/gmime-table-private.h          |    4 ++--
 gmime/internet-address.h             |    1 +
 10 files changed, 20 insertions(+), 29 deletions(-)
---
diff --git a/docs/reference/gmime-sections.txt b/docs/reference/gmime-sections.txt
index a8af244..02bf83c 100644
--- a/docs/reference/gmime-sections.txt
+++ b/docs/reference/gmime-sections.txt
@@ -844,7 +844,9 @@ GMimeMultipartSignedClass
 <SECTION>
 <FILE>gmime-application-pkcs7-mime</FILE>
 GMimeApplicationPkcs7Mime
+GMimeSecureMimeType
 g_mime_application_pkcs7_mime_new
+g_mime_application_pkcs7_mime_get_smime_type
 g_mime_application_pkcs7_mime_encrypt
 g_mime_application_pkcs7_mime_decrypt
 g_mime_application_pkcs7_mime_sign
diff --git a/gmime/gen-table.c b/gmime/gen-table.c
index 6705917..3a976ef 100644
--- a/gmime/gen-table.c
+++ b/gmime/gen-table.c
@@ -149,8 +149,8 @@ int main (int argc, char **argv)
        header_decode_init ();
        
        printf ("/* THIS FILE IS AUTOGENERATED: DO NOT EDIT! */\n\n");
-       printf ("/**\n * To regenerate:\n * make gen-table\n");
-       printf (" * ./gen-table > gmime-table-private.h\n **/\n\n");
+       printf ("/*\n * To regenerate:\n * make gen-table\n");
+       printf (" * ./gen-table > gmime-table-private.h\n */\n\n");
        
        /* print out the table */
        printf ("static unsigned short gmime_special_table[256] = {");
diff --git a/gmime/gmime-application-pkcs7-mime.h b/gmime/gmime-application-pkcs7-mime.h
index 8cd8412..f85aaee 100644
--- a/gmime/gmime-application-pkcs7-mime.h
+++ b/gmime/gmime-application-pkcs7-mime.h
@@ -60,6 +60,7 @@ typedef enum _GMimeSecureMimeType {
 /**
  * GMimeApplicationPkcs7Mime:
  * @parent_object: parent #GMimePart object
+ * @smime_type: The smime-type Content-Type parameter.
  *
  * An application/pkcs7-mime MIME part.
  **/
diff --git a/gmime/gmime-filter.h b/gmime/gmime-filter.h
index 38a0764..4081f67 100644
--- a/gmime/gmime-filter.h
+++ b/gmime/gmime-filter.h
@@ -42,16 +42,6 @@ typedef struct _GMimeFilterClass GMimeFilterClass;
  * GMimeFilter:
  * @parent_object: parent #GObject
  * @priv: private state data
- * @outreal: (array) (element-type guint8): real malloc'd buffer
- * @outbuf: (array length=outsize) (element-type guint8): first
- *   writable position allowed (outreal + outpre)
- * @outptr: current writale position
- * @outsize: current bytes in @outbuf
- * @outpre: current prespace of @outbuf
- * @backbuf: (array length=backsize) (element-type guint8): backup
- *   buffer
- * @backsize: backup buffer size
- * @backlen: number of bytes backed-up in @backbuf
  *
  * Base class for filters used by #GMimeStreamFilter.
  **/
@@ -61,15 +51,15 @@ struct _GMimeFilter {
        struct _GMimeFilterPrivate *priv;
        
        /* <protected> */
-       char *outreal;          /* real malloc'd buffer */
-       char *outbuf;           /* first 'writable' position allowed (outreal + outpre) */
-       char *outptr;
-       size_t outsize;
-       size_t outpre;          /* prespace of this buffer */
+       char *outreal;   /* real malloc'd buffer */
+       char *outbuf;    /* first 'writable' position allowed (@outreal + @outpre) */
+       char *outptr;    /* current writable position */
+       size_t outsize;  /* current bytes in @outbuf */
+       size_t outpre;   /* current prespace of @outbuf */
        
-       char *backbuf;
-       size_t backsize;
-       size_t backlen;         /* significant data there */
+       char *backbuf;   /* backup buffer */
+       size_t backsize; /* backup buffer size */
+       size_t backlen;  /* number of bytes backed-up in @backbuf */
 };
 
 struct _GMimeFilterClass {
diff --git a/gmime/gmime-message.h b/gmime/gmime-message.h
index f57a1fe..ddfcd2b 100644
--- a/gmime/gmime-message.h
+++ b/gmime/gmime-message.h
@@ -71,9 +71,7 @@ typedef enum _GMimeAddressType {
  * @mime_part: toplevel MIME part
  * @addrlists: a table of address lists
  * @message_id: Message-Id string
- * @reply_to: Reply-To string
  * @subject: Subject string
- * @from: From string
  * @date: Date value
  * @tz_offset: timezone offset
  *
diff --git a/gmime/gmime-multipart.h b/gmime/gmime-multipart.h
index 6cc5136..fa7d1c1 100644
--- a/gmime/gmime-multipart.h
+++ b/gmime/gmime-multipart.h
@@ -52,11 +52,13 @@ typedef struct _GMimeMultipartClass GMimeMultipartClass;
 struct _GMimeMultipart {
        GMimeObject parent_object;
        
-       gboolean write_end_boundary;
        GPtrArray *children;
        char *boundary;
        char *preface;
        char *postface;
+       
+       /* < private > */
+       gboolean write_end_boundary;
 };
 
 struct _GMimeMultipartClass {
diff --git a/gmime/gmime-parser.c b/gmime/gmime-parser.c
index 4b5d62e..5ee14c8 100644
--- a/gmime/gmime-parser.c
+++ b/gmime/gmime-parser.c
@@ -2001,6 +2001,7 @@ g_mime_parser_construct_message (GMimeParser *parser)
 /**
  * g_mime_parser_construct_message_with_options:
  * @parser: a #GMimeParser context
+ * @options: a #GMimeParserOptions
  *
  * Constructs a MIME message from @parser.
  *
diff --git a/gmime/gmime-stream.h b/gmime/gmime-stream.h
index 9d5b14d..99e3022 100644
--- a/gmime/gmime-stream.h
+++ b/gmime/gmime-stream.h
@@ -73,10 +73,6 @@ typedef struct {
 /**
  * GMimeStream:
  * @parent_object: parent #GObject
- * @super_stream: parent stream if this is a substream
- * @position: the current stream position
- * @bound_start: start boundary of the stream
- * @bound_end: end boundary of the stream
  *
  * Abstract I/O stream class.
  **/
diff --git a/gmime/gmime-table-private.h b/gmime/gmime-table-private.h
index baa95bd..5db0701 100644
--- a/gmime/gmime-table-private.h
+++ b/gmime/gmime-table-private.h
@@ -1,10 +1,10 @@
 /* THIS FILE IS AUTOGENERATED: DO NOT EDIT! */
 
-/**
+/*
  * To regenerate:
  * make gen-table
  * ./gen-table > gmime-table-private.h
- **/
+ */
 
 static unsigned short gmime_special_table[256] = {
        1029,1029,1029,1029,1029,1029,1029,1029,1029,3175,1031,1029,1029,1063,1029,1029,
diff --git a/gmime/internet-address.h b/gmime/internet-address.h
index ea09111..318f9f2 100644
--- a/gmime/internet-address.h
+++ b/gmime/internet-address.h
@@ -72,6 +72,7 @@ typedef struct _InternetAddressListClass InternetAddressListClass;
  * InternetAddress:
  * @parent_object: parent #GObject
  * @priv: private data
+ * @charset: the charset used for encoding the name
  * @name: display name
  *
  * An RFC 2822 Address object.


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