X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=lib%2Fnotmuch.h;h=037913f40303e0153db912e1e5d883530b6ffe78;hb=a962bd2bf801b80e2bdfaa8b05797bf01bc3fc1f;hp=34666b888e750f65023c9f4c95e2807b5c922779;hpb=7ad7cfbff232431377562271901ee00202bf0bd0;p=notmuch diff --git a/lib/notmuch.h b/lib/notmuch.h index 34666b88..037913f4 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -1363,9 +1363,8 @@ notmuch_message_get_database (const notmuch_message_t *message); * message is valid, (which is until the query from which it derived * is destroyed). * - * This function will not return NULL since Notmuch ensures that every - * message has a unique message ID, (Notmuch will generate an ID for a - * message if the original file does not contain one). + * This function will return NULL if triggers an unhandled Xapian + * exception. */ const char * notmuch_message_get_message_id (notmuch_message_t *message); @@ -1403,7 +1402,10 @@ notmuch_message_get_thread_id (notmuch_message_t *message); * 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. + * This function also returns NULL if it triggers a Xapian exception. + * + * The returned list will be destroyed when the thread is + * destroyed. */ notmuch_messages_t * notmuch_message_get_replies (notmuch_message_t *message); @@ -2312,7 +2314,7 @@ notmuch_indexopts_destroy (notmuch_indexopts_t *options); */ notmuch_bool_t notmuch_built_with (const char *name); -/* @} */ +/**@}*/ #pragma GCC visibility pop