[gmime/gmime-2-4] Updated GMimeObject docs for the raw header APIs



commit 724cde406dd26b447797f72f82c34bf90c9ef543
Author: Jeffrey Stedfast <fejj gnome org>
Date:   Wed Jun 13 20:14:24 2012 -0400

    Updated GMimeObject docs for the raw header APIs

 gmime/gmime-object.c |   14 +++++++-------
 1 files changed, 7 insertions(+), 7 deletions(-)
---
diff --git a/gmime/gmime-object.c b/gmime/gmime-object.c
index 9ccde9b..7584134 100644
--- a/gmime/gmime-object.c
+++ b/gmime/gmime-object.c
@@ -776,7 +776,7 @@ prepend_header (GMimeObject *object, const char *header, const char *value)
  * @header: header name
  * @value: header value
  *
- * Prepends a header to the MIME object.
+ * Prepends a raw, unprocessed header to the MIME object.
  **/
 void
 g_mime_object_prepend_header (GMimeObject *object, const char *header, const char *value)
@@ -802,7 +802,7 @@ append_header (GMimeObject *object, const char *header, const char *value)
  * @header: header name
  * @value: header value
  *
- * Appends a header to the MIME object.
+ * Appends a raw, unprocessed header to the MIME object.
  **/
 void
 g_mime_object_append_header (GMimeObject *object, const char *header, const char *value)
@@ -829,7 +829,7 @@ set_header (GMimeObject *object, const char *header, const char *value)
  * @header: header name
  * @value: header value
  *
- * Sets an arbitrary header on the MIME object.
+ * Sets an arbitrary raw, unprocessed header on the MIME object.
  **/
 void
 g_mime_object_set_header (GMimeObject *object, const char *header, const char *value)
@@ -854,11 +854,11 @@ get_header (GMimeObject *object, const char *header)
  * @object: a #GMimeObject
  * @header: header name
  *
- * Gets the value of the requested header if it exists or %NULL
- * otherwise.
+ * Gets the raw, unprocessed value of the requested header if it
+ * exists or %NULL otherwise.
  *
- * Returns: the value of the header @header if it exists or %NULL
- * otherwise.
+ * Returns: the raw, unprocessed value of the header @header if it
+ * exists or %NULL otherwise.
  **/
 const char *
 g_mime_object_get_header (GMimeObject *object, const char *header)



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