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 77ed0328da6d4c8bcd6339b7e387a6b765bf9d7f..103d233118e0d4f27f0e46770809ec6cc3e8df73 100644 (file)
--- 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);
 
 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
  *
  * 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);
 
 const char *
 notmuch_message_get_filename (notmuch_message_t *message);