summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorrhn <gihu.rhn@porcupinefactory.org>2018-12-17 17:57:46 +0000
committerDavid Bremner <david@tethera.net>2019-01-25 20:34:57 -0400
commit45639881b5ddb56492bd3ba329e982517cc9ef54 (patch)
treeb3a90873986c0b083090f5880501603495c8996a /lib
parente52535029b3976589e2817da515fd98120718947 (diff)
lib: Explicitly state when replies will be destroyed
Without an explicit guarantee, it's not clear how to use the reference.
Diffstat (limited to 'lib')
-rw-r--r--lib/notmuch.h2
1 files changed, 2 insertions, 0 deletions
diff --git a/lib/notmuch.h b/lib/notmuch.h
index 247f6ad7..aa032e09 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -1400,6 +1400,8 @@ notmuch_message_get_thread_id (notmuch_message_t *message);
* If there are no replies to 'message', this function will return
* NULL. (Note that notmuch_messages_valid will accept that NULL
* value as legitimate, and simply return FALSE for it.)
+ *
+ * The returned list will be destroyed when the thread is destroyed.
*/
notmuch_messages_t *
notmuch_message_get_replies (notmuch_message_t *message);