lib: Document which strings are returned in UTF-8

Any string that ultimately comes from notmuch_message_file_get_header
is in UTF-8.
This commit is contained in:
Austin Clements 2013-08-12 14:40:35 -04:00 committed by David Bremner
parent a7bf045fb1
commit 3fbb518335
2 changed files with 4 additions and 4 deletions

View file

@ -386,7 +386,7 @@ void
notmuch_message_file_restrict_headersv (notmuch_message_file_t *message, notmuch_message_file_restrict_headersv (notmuch_message_file_t *message,
va_list va_headers); va_list va_headers);
/* Get the value of the specified header from the message. /* Get the value of the specified header from the message as a UTF-8 string.
* *
* The header name is case insensitive. * The header name is case insensitive.
* *

View file

@ -767,7 +767,7 @@ notmuch_thread_get_messages (notmuch_thread_t *thread);
int int
notmuch_thread_get_matched_messages (notmuch_thread_t *thread); notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
/* Get the authors of 'thread' /* Get the authors of 'thread' as a UTF-8 string.
* *
* The returned string is a comma-separated list of the names of the * The returned string is a comma-separated list of the names of the
* authors of mail messages in the query results that belong to this * authors of mail messages in the query results that belong to this
@ -781,7 +781,7 @@ notmuch_thread_get_matched_messages (notmuch_thread_t *thread);
const char * const char *
notmuch_thread_get_authors (notmuch_thread_t *thread); notmuch_thread_get_authors (notmuch_thread_t *thread);
/* Get the subject of 'thread' /* Get the subject of 'thread' as a UTF-8 string.
* *
* The subject is taken from the first message (according to the query * The subject is taken from the first message (according to the query
* order---see notmuch_query_set_sort) in the query results that * order---see notmuch_query_set_sort) in the query results that
@ -1013,7 +1013,7 @@ notmuch_message_set_flag (notmuch_message_t *message,
time_t time_t
notmuch_message_get_date (notmuch_message_t *message); notmuch_message_get_date (notmuch_message_t *message);
/* Get the value of the specified header from 'message'. /* Get the value of the specified header from 'message' as a UTF-8 string.
* *
* Common headers are stored in the database when the message is * Common headers are stored in the database when the message is
* indexed and will be returned from the database. Other headers will * indexed and will be returned from the database. Other headers will