lib: Explicitly state when replies will be destroyed

Without an explicit guarantee, it's not clear how to use the reference.
This commit is contained in:
rhn 2018-12-17 17:57:46 +00:00 committed by David Bremner
parent e52535029b
commit 45639881b5

View file

@ -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);