GNOME.org
 

[gmime] documentation fixes

commit 9ee16cf786341b9faf0928b4c09b2d4b9f3de99e
Author: Jeffrey Stedfast <jestedfa microsoft com>
Date:   Fri Dec 9 16:06:57 2016 -0500

    documentation fixes

 docs/reference/Makefile.am        |    1 +
 gmime/gmime-content-type.h        |    1 +
 gmime/gmime-crypto-context.c      |    7 +++++--
 gmime/gmime-disposition.h         |    1 +
 gmime/gmime-filter-crlf.h         |    7 ++++---
 gmime/gmime-gpg-context.c         |   33 ++++++++++++++++++---------------
 gmime/gmime-gpg-context.h         |    3 +++
 gmime/gmime-multipart-encrypted.h |    2 --
 gmime/gmime-object.h              |    4 ++--
 gmime/gmime-stream.c              |    2 +-
 gmime/gmime-utils.c               |    2 +-
 11 files changed, 37 insertions(+), 26 deletions(-)
---
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 6f02d74..683a36e 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -58,6 +58,7 @@ 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             \
diff --git a/gmime/gmime-content-type.h b/gmime/gmime-content-type.h
index e1f5e37..3938dd1 100644
--- a/gmime/gmime-content-type.h
+++ b/gmime/gmime-content-type.h
@@ -44,6 +44,7 @@ typedef struct _GMimeContentTypeClass GMimeContentTypeClass;
  * @parent_object: parent #GObject
  * @param_hash: parameter hash keyed by param name
  * @params: a #GMimeParam list
+ * @priv: private fields
  * @type: media type
  * @subtype: media subtype
  *
diff --git a/gmime/gmime-crypto-context.c b/gmime/gmime-crypto-context.c
index 9da02b7..2ae77c6 100644
--- a/gmime/gmime-crypto-context.c
+++ b/gmime/gmime-crypto-context.c
@@ -178,8 +178,11 @@ crypto_get_retrieve_session_key (GMimeCryptoContext *ctx)
  * g_mime_crypto_context_get_retrieve_session_key:
  * @ctx: a #GMimeCryptoContext
  *
- * Returns: an indication of whether @ctx is configured to retrieve a
- * session key during decryption (see g_mime_decrypt_result_get_session_key()).
+ * Gets whether or not the @ctx is configured to retrieve a session
+ * key during decryption (see g_mime_decrypt_result_get_session_key()).
+ *
+ * Returns: %TRUE if the @ctx is configured to retrieve a session key
+ * or %FALSE otherwise.
  **/
 gboolean
 g_mime_crypto_context_get_retrieve_session_key (GMimeCryptoContext *ctx)
diff --git a/gmime/gmime-disposition.h b/gmime/gmime-disposition.h
index 16080c7..2a2f3e6 100644
--- a/gmime/gmime-disposition.h
+++ b/gmime/gmime-disposition.h
@@ -60,6 +60,7 @@ typedef struct _GMimeContentDispositionClass GMimeContentDispositionClass;
  * @parent_object: parent #GObject
  * @param_hash: parameter hash table keyed by param name
  * @params: a #GMimeParam list
+ * @priv: private fields
  * @disposition: disposition
  *
  * A data structure representing a Content-Disposition.
diff --git a/gmime/gmime-filter-crlf.h b/gmime/gmime-filter-crlf.h
index 370314e..a732734 100644
--- a/gmime/gmime-filter-crlf.h
+++ b/gmime/gmime-filter-crlf.h
@@ -40,9 +40,10 @@ typedef struct _GMimeFilterCRLFClass GMimeFilterCRLFClass;
  * GMimeFilterCRLF:
  * @parent_object: parent #GMimeFilter
  * @encode: encoding vs decoding line endings/dots
- * @saw_cr: previous char was a CR
- * @saw_lf: previous char was a LF
- * @saw_dot: previous char was a period
+ * @dots: %TRUE if dot-stuffing should be performed or %FALSE otherwise
+ * @saw_cr: %TRUE if the previous char was a CR
+ * @saw_lf: %TRUE if the previous char was a LF
+ * @saw_dot: %TRUE if the previous char was a period
  *
  * A filter to convert between line-ending formats and encode/decode
  * lines beginning with a '.'.
diff --git a/gmime/gmime-gpg-context.c b/gmime/gmime-gpg-context.c
index bd9e102..9d54458 100644
--- a/gmime/gmime-gpg-context.c
+++ b/gmime/gmime-gpg-context.c
@@ -2314,9 +2314,11 @@ g_mime_gpg_context_new (GMimePasswordRequestFunc request_passwd, const char *pat
  * g_mime_gpg_context_get_auto_key_retrieve:
  * @ctx: a #GMimeGpgContext
  *
- * Gets the @auto_key_retrieve flag on the gpg context.
+ * Gets whether or not gpg should auto-retrieve keys from a keyserver
+ * when verifying signatures.
  *
- * Returns: the @auto_key_retrieve flag on the gpg context.
+ * Returns: %TRUE if gpg should auto-retrieve keys from a keyserver or
+ * %FALSE otherwise.
  **/
 gboolean
 g_mime_gpg_context_get_auto_key_retrieve (GMimeGpgContext *ctx)
@@ -2330,10 +2332,10 @@ g_mime_gpg_context_get_auto_key_retrieve (GMimeGpgContext *ctx)
 /**
  * g_mime_gpg_context_set_auto_key_retrieve:
  * @ctx: a #GMimeGpgContext
- * @auto_key_retrieve: auto-retrieve keys from a keys server
+ * @auto_key_retrieve: %TRUE if gpg should auto-retrieve keys from a keys server
  *
- * Sets the @auto_key_retrieve flag on the gpg context which is used
- * for signature verification.
+ * Sets whether or not gpg should auto-retrieve keys from a keyserver
+ * when verifying signatures.
  **/
 void
 g_mime_gpg_context_set_auto_key_retrieve (GMimeGpgContext *ctx, gboolean auto_key_retrieve)
@@ -2348,9 +2350,10 @@ g_mime_gpg_context_set_auto_key_retrieve (GMimeGpgContext *ctx, gboolean auto_ke
  * g_mime_gpg_context_get_always_trust:
  * @ctx: a #GMimeGpgContext
  *
- * Gets the always_trust flag on the gpg context.
+ * Gets whther or not gpg should always trust keys when encrypting.
  *
- * Returns: the always_trust flag on the gpg context.
+ * Returns: %TRUE if gpg should always trust keys when encrypting or
+ * %FALSE otherwise.
  **/
 gboolean
 g_mime_gpg_context_get_always_trust (GMimeGpgContext *ctx)
@@ -2364,10 +2367,9 @@ g_mime_gpg_context_get_always_trust (GMimeGpgContext *ctx)
 /**
  * g_mime_gpg_context_set_always_trust:
  * @ctx: a #GMimeGpgContext
- * @always_trust: always trust flag
+ * @always_trust: %TRUE if gpg should always trust keys when encrypting
  *
- * Sets the @always_trust flag on the gpg context which is used for
- * encryption.
+ * Sets whether or not gpg should always trust keys when encrypting.
  **/
 void
 g_mime_gpg_context_set_always_trust (GMimeGpgContext *ctx, gboolean always_trust)
@@ -2382,10 +2384,11 @@ g_mime_gpg_context_set_always_trust (GMimeGpgContext *ctx, gboolean always_trust
  * g_mime_gpg_context_get_use_agent:
  * @ctx: a #GMimeGpgContext
  *
- * Gets the use_agent flag on the gpg context.
+ * Gets whether or not gpg should attempt to use the gpg-agent when
+ * requesting credentials.
  *
- * Returns: the use_agent flag on the gpg context, which indicates
- * that GnuPG should attempt to use gpg-agent for credentials.
+ * Returns: %TRUE if the gpg-agent should be used when requesting
+ * credentials or %FALSE otherwise.
  **/
 gboolean
 g_mime_gpg_context_get_use_agent (GMimeGpgContext *ctx)
@@ -2401,8 +2404,8 @@ g_mime_gpg_context_get_use_agent (GMimeGpgContext *ctx)
  * @ctx: a #GMimeGpgContext
  * @use_agent: use agent flag
  *
- * Sets the @use_agent flag on the gpg context, which indicates that
- * GnuPG should attempt to use gpg-agent for credentials.
+ * Sets whether or not gpg should attempt to use the gpg-agent when
+ * requesting credentials.
  **/
 void
 g_mime_gpg_context_set_use_agent (GMimeGpgContext *ctx, gboolean use_agent)
diff --git a/gmime/gmime-gpg-context.h b/gmime/gmime-gpg-context.h
index 646a5a4..8625d33 100644
--- a/gmime/gmime-gpg-context.h
+++ b/gmime/gmime-gpg-context.h
@@ -40,8 +40,11 @@ typedef struct _GMimeGpgContextClass GMimeGpgContextClass;
 /**
  * GMimeGpgContext:
  * @parent_object: parent #GMimeCryptoContext
+ * @auto_key_retrieve: %TRUE if gpg should automatically retrieve unknown keys from the web
  * @always_trust: %TRUE if keys should always be trusted
+ * @use_agent: %TRUE if gpg should use the gpg-agent for requesting passphrases
  * @path: path to gpg
+ * @retrieve_session_key: %TRUE if session keys should be retrieved when decrypting
  *
  * A GnuPG crypto context.
  **/
diff --git a/gmime/gmime-multipart-encrypted.h b/gmime/gmime-multipart-encrypted.h
index da154a2..0e53b1e 100644
--- a/gmime/gmime-multipart-encrypted.h
+++ b/gmime/gmime-multipart-encrypted.h
@@ -46,8 +46,6 @@ enum {
 /**
  * GMimeMultipartEncrypted:
  * @parent_object: parent #GMimeMultipart
- * @validity: a #GMimeSignatureValidity if the part has been decrypted or %NULL otherwise
- * @decrypted: cached decrypted MIME part
  *
  * A multipart/encrypted MIME part.
  **/
diff --git a/gmime/gmime-object.h b/gmime/gmime-object.h
index e8235b0..10d1576 100644
--- a/gmime/gmime-object.h
+++ b/gmime/gmime-object.h
@@ -112,8 +112,8 @@ GMimeContentDisposition *g_mime_object_get_content_disposition (GMimeObject *obj
 void g_mime_object_set_disposition (GMimeObject *object, const char *disposition);
 const char *g_mime_object_get_disposition (GMimeObject *object);
 
-void g_mime_object_set_content_disposition_parameter (GMimeObject *object, const char *attribute, const char 
*value);
-const char *g_mime_object_get_content_disposition_parameter (GMimeObject *object, const char *attribute);
+void g_mime_object_set_content_disposition_parameter (GMimeObject *object, const char *name, const char 
*value);
+const char *g_mime_object_get_content_disposition_parameter (GMimeObject *object, const char *name);
 
 void g_mime_object_set_content_id (GMimeObject *object, const char *content_id);
 const char *g_mime_object_get_content_id (GMimeObject *object);
diff --git a/gmime/gmime-stream.c b/gmime/gmime-stream.c
index f10a2fd..6512294 100644
--- a/gmime/gmime-stream.c
+++ b/gmime/gmime-stream.c
@@ -498,7 +498,7 @@ g_mime_stream_write_string (GMimeStream *stream, const char *str)
  * g_mime_stream_printf:
  * @stream: a #GMimeStream
  * @fmt: format
- * @Varargs: arguments
+ * @...: arguments
  *
  * Write formatted output to a stream.
  *
diff --git a/gmime/gmime-utils.c b/gmime/gmime-utils.c
index 648a684..229bd9f 100644
--- a/gmime/gmime-utils.c
+++ b/gmime/gmime-utils.c
@@ -2979,7 +2979,7 @@ g_mime_utils_header_fold (const char *header)
 /**
  * g_mime_utils_header_printf:
  * @format: string format
- * @Varargs: arguments
+ * @...: arguments
  *
  * Allocates a buffer containing a formatted header specified by the
  * @Varargs.
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]