debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-22 02:48:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

notmuch_message_get_filename: Improve documentation.

Browse source 
Fix a typo, and add clarifications about the lifetime and readonly
nature of the return value.
This commit is contained in:
Carl Worth 2009-10-23 15:12:03 -07:00
parent fb1bae0700
commit 03c40c2bb0
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
notmuch.h
View file

@ -408,10 +408,13 @@ notmuch_results_destroy (notmuch_results_t *results);
const char *
notmuch_message_get_message_id (notmuch_message_t *message);
/* Get this filename for the email corresponding to 'message'.
/* Get the filename for the email corresponding to 'message'.
*
* The returned filename is relative to the base of the database from
* which 'message' was obtained. See notmuch_database_get_path() .*/
* which 'message' was obtained. See notmuch_database_get_path() .
* The returned string belongs to the message so should not be
* modified or freed by the caller (nor should it be referenced after
* the message is destroyed). */
const char *
notmuch_message_get_filename (notmuch_message_t *message);