debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2025-02-17 23:53:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

lib: Document extent of some return values

Browse source 
This documents the extent of the notmuch_messages_t* pointers returned
by notmuch_thread_get_toplevel_messages and
notmuch_thread_get_messages.
This commit is contained in:
Austin Clements 2013-10-24 11:19:03 -04:00 • committed by David Bremner
parent a24cd45568
commit 215a8dc29c
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
lib/notmuch.h
View file

@ -794,12 +794,16 @@ notmuch_thread_get_total_messages (notmuch_thread_t *thread);
* This iterator will not necessarily iterate over all of the messages * This iterator will not necessarily iterate over all of the messages
* in the thread. It will only iterate over the messages in the thread * in the thread. It will only iterate over the messages in the thread
* which are not replies to other 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_messages_t *
notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread); notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);
/* Get a notmuch_thread_t iterator for all messages in 'thread' in /* Get a notmuch_thread_t iterator for all messages in 'thread' in
* oldest-first order. * oldest-first order.
*
* The returned list will be destroyed when the thread is destroyed.
*/ */
notmuch_messages_t * notmuch_messages_t *
notmuch_thread_get_messages (notmuch_thread_t *thread); notmuch_thread_get_messages (notmuch_thread_t *thread);