From 215a8dc29c200bda1ecdbbbd44a57e2d32264ef1 Mon Sep 17 00:00:00 2001 From: Austin Clements Date: Thu, 24 Oct 2013 11:19:03 -0400 Subject: [PATCH] lib: Document extent of some return values This documents the extent of the notmuch_messages_t* pointers returned by notmuch_thread_get_toplevel_messages and notmuch_thread_get_messages. --- lib/notmuch.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/notmuch.h b/lib/notmuch.h index 6c3942d3..7c3a30c1 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -794,12 +794,16 @@ notmuch_thread_get_total_messages (notmuch_thread_t *thread); * This iterator will not necessarily iterate over all of the messages * in the thread. It will only iterate over the messages in the thread * which are not replies to other messages in the thread. + * + * The returned list will be destroyed when the thread is destroyed. */ notmuch_messages_t * notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread); /* Get a notmuch_thread_t iterator for all messages in 'thread' in * oldest-first order. + * + * The returned list will be destroyed when the thread is destroyed. */ notmuch_messages_t * notmuch_thread_get_messages (notmuch_thread_t *thread);