From: Carl Worth <cworth@cworth.org>
Date: Fri, 23 Oct 2009 22:12:03 +0000 (-0700)
Subject: notmuch_message_get_filename: Improve documentation.
X-Git-Tag: 0.1~747
X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=commitdiff_plain;h=03c40c2bb04a762539e5fbc9924a1ce1e5548cc8

notmuch_message_get_filename: Improve documentation.

Fix a typo, and add clarifications about the lifetime and readonly
nature of the return value.
---

diff --git a/notmuch.h b/notmuch.h
index 77ed0328..103d2331 100644
--- a/notmuch.h
+++ b/notmuch.h
@@ -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);