[gmime: 4/24] Fixed docs thanks to Peter Bloomfield's critical eye ; )
- From: Jeffrey Stedfast <fejj src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gmime: 4/24] Fixed docs thanks to Peter Bloomfield's critical eye ; )
- Date: Sat, 26 Aug 2017 13:20:05 +0000 (UTC)
commit 893b51cd32533325e44b0dec47ff63025897d99f
Author: Jeffrey Stedfast <jestedfa microsoft com>
Date: Mon Jun 26 09:17:31 2017 -0400
Fixed docs thanks to Peter Bloomfield's critical eye ;)
gmime/gmime-header.c | 7 ++-----
1 files changed, 2 insertions(+), 5 deletions(-)
---
diff --git a/gmime/gmime-header.c b/gmime/gmime-header.c
index df6a961..2333e81 100644
--- a/gmime/gmime-header.c
+++ b/gmime/gmime-header.c
@@ -246,10 +246,7 @@ unfold (const char *value)
*
* Gets the header's unfolded value.
*
- * Returns: the header's unfolded value or %NULL if invalid.
- *
- * Note: The returned value should be decoded with a function such as
- * g_mime_utils_header_decode_text() before displaying to the user.
+ * Returns: the header's decoded value or %NULL if invalid.
**/
const char *
g_mime_header_get_value (GMimeHeader *header)
@@ -275,7 +272,7 @@ g_mime_header_get_value (GMimeHeader *header)
* @value: the new header value
* @charset: a charset
*
- * Sets the header's (unfolded) value.
+ * Sets the header's decoded value.
**/
void
g_mime_header_set_value (GMimeHeader *header, GMimeFormatOptions *options, const char *value, const char
*charset)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]