From: Austin Clements <amdragon@MIT.EDU>
To: notmuch@notmuchmail.org
Subject: [PATCH v2 03/11] lib: Document extent of some return values
Date: Thu, 24 Oct 2013 11:19:03 -0400
Message-Id: <1382627951-25252-4-git-send-email-amdragon@mit.edu>
In-Reply-To: <1382627951-25252-1-git-send-email-amdragon@mit.edu>
References: <1382627951-25252-1-git-send-email-amdragon@mit.edu>
Precedence: list

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 9dab555..0fb7121 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -765,12 +765,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);
-- 
1.8.4.rc3