From: Jani Nikula Date: Wed, 6 Nov 2013 17:35:41 +0000 (+0200) Subject: [RFC PATCH 2/2] lib: modify notmuch.h for automatic document generation X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=9c734f9a9b7652ccdd4d590b3c1daab3286f9ac2;p=notmuch-archives.git [RFC PATCH 2/2] lib: modify notmuch.h for automatic document generation --- diff --git a/0c/d548d6b6a72f2528eec6d201f9dd3be9d99150 b/0c/d548d6b6a72f2528eec6d201f9dd3be9d99150 new file mode 100644 index 000000000..d11a107c4 --- /dev/null +++ b/0c/d548d6b6a72f2528eec6d201f9dd3be9d99150 @@ -0,0 +1,1099 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 721B9429E5A + for ; Wed, 6 Nov 2013 09:36:06 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References" +X-Spam-Flag: NO +X-Spam-Score: -0.7 +X-Spam-Level: +X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5 + tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id GSZQQZ3aS9HI for ; + Wed, 6 Nov 2013 09:35:56 -0800 (PST) +Received: from mail-ea0-f172.google.com (mail-ea0-f172.google.com + [209.85.215.172]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) + (No client certificate requested) + by olra.theworths.org (Postfix) with ESMTPS id EB653429E59 + for ; Wed, 6 Nov 2013 09:35:55 -0800 (PST) +Received: by mail-ea0-f172.google.com with SMTP id r16so5193815ead.3 + for ; Wed, 06 Nov 2013 09:35:54 -0800 (PST) +X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; + d=1e100.net; s=20130820; + h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to + :references:in-reply-to:references; + bh=68ipSPoxz3N3pFDYbLOm80oyw/uUHFf7nzhKKiy4Vow=; + b=PZEQPkVcj2QD0UIPJtR2qVL1LzIyuomwvOR2ZbGjgKPGT8Wk4+8C5L1qk2qri/d+Tr + XfuAW84MmV5g1xsbbMV/wOmb+yUQP3IEPdatsG9d0Ym+Ojf8fF58Co0dDMiWZN506GyI + HU/KDyZU4aUkm5UsxrHP9w+TZIlo3sp8ijUrZt+epm1oDf6hQpatyzLAM9HP3BG6uZ99 + Gwo7bpZEbdzvj1RU/OVTfNDwoPzViB2mPC7mor8pXutJwdBCp3FS4KhZczaRN9M9yaC9 + 01LzNa8nOgKPNP0m+5ECDLKBdchgFatc4HC0iltDXfH7HnJ2EDy9FPJws3z0dYCJ/5fm + 9gyA== +X-Gm-Message-State: + ALoCoQn/8RM8dRLnkJqhAfShWMmamuIuanxzkeq86I/8a7MKreFSMSF94XbLidhnJvpwD+7uHZ68 +X-Received: by 10.15.64.1 with SMTP id n1mr4863750eex.15.1383759354839; + Wed, 06 Nov 2013 09:35:54 -0800 (PST) +Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi. + [88.195.111.91]) + by mx.google.com with ESMTPSA id w6sm76385237eeo.12.2013.11.06.09.35.52 + for + (version=TLSv1.2 cipher=RC4-SHA bits=128/128); + Wed, 06 Nov 2013 09:35:54 -0800 (PST) +From: Jani Nikula +To: notmuch@notmuchmail.org +Subject: [RFC PATCH 2/2] lib: modify notmuch.h for automatic document + generation +Date: Wed, 6 Nov 2013 19:35:41 +0200 +Message-Id: + <2835d28b1ddec0338f906b5165494f0fda5cb388.1383758666.git.jani@nikula.org> +X-Mailer: git-send-email 1.8.4.rc3 +In-Reply-To: +References: +In-Reply-To: +References: +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Wed, 06 Nov 2013 17:36:06 -0000 + +Minimal changes to produce a sensible result. +--- + lib/notmuch.h | 426 +++++++++++++++++++++++++++++++++++++++------------------- + 1 file changed, 289 insertions(+), 137 deletions(-) + +diff --git a/lib/notmuch.h b/lib/notmuch.h +index 9dab555..6d91b17 100644 +--- a/lib/notmuch.h ++++ b/lib/notmuch.h +@@ -18,9 +18,19 @@ + * Author: Carl Worth + */ + ++/** ++ * @defgroup notmuch The notmuch API ++ * ++ * Not much of an email library, (just index and search) ++ * ++ * @{ ++ */ ++ + #ifndef NOTMUCH_H + #define NOTMUCH_H + ++#ifndef __DOXYGEN__ ++ + #ifdef __cplusplus + # define NOTMUCH_BEGIN_DECLS extern "C" { + # define NOTMUCH_END_DECLS } +@@ -33,6 +43,8 @@ NOTMUCH_BEGIN_DECLS + + #include + ++#endif /* __DOXYGEN__ */ ++ + #ifndef FALSE + #define FALSE 0 + #endif +@@ -41,72 +53,87 @@ NOTMUCH_BEGIN_DECLS + #define TRUE 1 + #endif + ++/** ++ * Notmuch boolean type. ++ */ + typedef int notmuch_bool_t; + +-/* Status codes used for the return values of most functions. ++/** ++ * Status codes used for the return values of most functions. + * + * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function +- * completed without error. Any other value indicates an error as +- * follows: +- * +- * NOTMUCH_STATUS_SUCCESS: No error occurred. +- * +- * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory +- * +- * XXX: We don't really want to expose this lame XAPIAN_EXCEPTION +- * value. Instead we should map to things like DATABASE_LOCKED or +- * whatever. +- * +- * NOTMUCH_STATUS_READ_ONLY_DATABASE: An attempt was made to write to +- * a database opened in read-only mode. ++ * completed without error. Any other value indicates an error. + * +- * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred +- * +- * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to read or +- * write to a file (this could be file not found, permission +- * denied, etc.) +- * +- * NOTMUCH_STATUS_FILE_NOT_EMAIL: A file was presented that doesn't +- * appear to be an email message. +- * +- * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: A file contains a message ID +- * that is identical to a message already in the database. +- * +- * NOTMUCH_STATUS_NULL_POINTER: The user erroneously passed a NULL +- * pointer to a notmuch function. +- * +- * NOTMUCH_STATUS_TAG_TOO_LONG: A tag value is too long (exceeds +- * NOTMUCH_TAG_MAX) +- * +- * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: The notmuch_message_thaw +- * function has been called more times than notmuch_message_freeze. +- * +- * NOTMUCH_STATUS_UNBALANCED_ATOMIC: notmuch_database_end_atomic has +- * been called more times than notmuch_database_begin_atomic. +- * +- * And finally: +- * +- * NOTMUCH_STATUS_LAST_STATUS: Not an actual status value. Just a way +- * to find out how many valid status values there are. + */ + typedef enum _notmuch_status { ++ /** ++ * No error occurred. ++ */ + NOTMUCH_STATUS_SUCCESS = 0, ++ /** ++ * Out of memory. ++ */ + NOTMUCH_STATUS_OUT_OF_MEMORY, ++ /** ++ * An attempt was made to write to a database opened in read-only ++ * mode. ++ */ + NOTMUCH_STATUS_READ_ONLY_DATABASE, ++ /** ++ * A Xapian exception occurred. ++ */ + NOTMUCH_STATUS_XAPIAN_EXCEPTION, ++ /** ++ * An error occurred trying to read or write to a file (this could ++ * be file not found, permission denied, etc.) ++ * ++ * @todo We don't really want to expose this lame XAPIAN_EXCEPTION ++ * value. Instead we should map to things like DATABASE_LOCKED or ++ * whatever. ++ */ + NOTMUCH_STATUS_FILE_ERROR, ++ /** ++ * A file was presented that doesn't appear to be an email ++ * message. ++ */ + NOTMUCH_STATUS_FILE_NOT_EMAIL, ++ /** ++ * A file contains a message ID that is identical to a message ++ * already in the database. ++ */ + NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID, ++ /** ++ * The user erroneously passed a NULL pointer to a notmuch ++ * function. ++ */ + NOTMUCH_STATUS_NULL_POINTER, ++ /** ++ * A tag value is too long (exceeds NOTMUCH_TAG_MAX). ++ */ + NOTMUCH_STATUS_TAG_TOO_LONG, ++ /** ++ * The notmuch_message_thaw function has been called more times ++ * than notmuch_message_freeze. ++ */ + NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW, ++ /** ++ * notmuch_database_end_atomic has been called more times than ++ * notmuch_database_begin_atomic. ++ */ + NOTMUCH_STATUS_UNBALANCED_ATOMIC, ++ /** ++ * The operation is not supported. ++ */ + NOTMUCH_STATUS_UNSUPPORTED_OPERATION, +- ++ /** ++ * Not an actual status value. Just a way to find out how many ++ * valid status values there are. ++ */ + NOTMUCH_STATUS_LAST_STATUS + } notmuch_status_t; + +-/* Get a string representation of a notmuch_status_t value. ++/** ++ * Get a string representation of a notmuch_status_t value. + * + * The result is read-only. + */ +@@ -125,7 +152,8 @@ typedef struct _notmuch_tags notmuch_tags_t; + typedef struct _notmuch_directory notmuch_directory_t; + typedef struct _notmuch_filenames notmuch_filenames_t; + +-/* Create a new, empty notmuch database located at 'path'. ++/** ++ * Create a new, empty notmuch database located at 'path'. + * + * The path should be a top-level directory to a collection of + * plain-text email messages (one message per file). This call will +@@ -161,12 +189,22 @@ typedef struct _notmuch_filenames notmuch_filenames_t; + notmuch_status_t + notmuch_database_create (const char *path, notmuch_database_t **database); + ++/** ++ * Database open mode for notmuch_database_open. ++ */ + typedef enum { ++ /** ++ * Open database for reading only. ++ */ + NOTMUCH_DATABASE_MODE_READ_ONLY = 0, ++ /** ++ * Open database for reading and writing. ++ */ + NOTMUCH_DATABASE_MODE_READ_WRITE + } notmuch_database_mode_t; + +-/* Open an existing notmuch database located at 'path'. ++/** ++ * Open an existing notmuch database located at 'path'. + * + * The database should have been created at some time in the past, + * (not necessarily by this process), by calling +@@ -202,7 +240,8 @@ notmuch_database_open (const char *path, + notmuch_database_mode_t mode, + notmuch_database_t **database); + +-/* Close the given notmuch database. ++/** ++ * Close the given notmuch database. + * + * After notmuch_database_close has been called, calls to other + * functions on objects derived from this database may either behave +@@ -216,50 +255,59 @@ notmuch_database_open (const char *path, + void + notmuch_database_close (notmuch_database_t *database); + +-/* A callback invoked by notmuch_database_compact to notify the user ++/** ++ * A callback invoked by notmuch_database_compact to notify the user + * of the progress of the compaction process. + */ + typedef void (*notmuch_compact_status_cb_t)(const char*); + +-/* Compact a notmuch database, backing up the original database to the ++/** ++ * Compact a notmuch database, backing up the original database to the + * given path. + * + * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE + * during the compaction process to ensure no writes are made. +- * + */ + notmuch_status_t + notmuch_database_compact (const char* path, + const char* backup_path, + notmuch_compact_status_cb_t status_cb); + +-/* Destroy the notmuch database, closing it if necessary and freeing ++/** ++ * Destroy the notmuch database, closing it if necessary and freeing + * all associated resources. + */ + void + notmuch_database_destroy (notmuch_database_t *database); + +-/* Return the database path of the given database. ++/** ++ * Return the database path of the given database. + * + * The return value is a string owned by notmuch so should not be +- * modified nor freed by the caller. */ ++ * modified nor freed by the caller. ++ */ + const char * + notmuch_database_get_path (notmuch_database_t *database); + +-/* Return the database format version of the given database. */ ++/** ++ * Return the database format version of the given database. ++ */ + unsigned int + notmuch_database_get_version (notmuch_database_t *database); + +-/* Does this database need to be upgraded before writing to it? ++/** ++ * Does this database need to be upgraded before writing to it? + * + * If this function returns TRUE then no functions that modify the + * database (notmuch_database_add_message, notmuch_message_add_tag, + * notmuch_directory_set_mtime, etc.) will work unless the function +- * notmuch_database_upgrade is called successfully first. */ ++ * notmuch_database_upgrade is called successfully first. ++ */ + notmuch_bool_t + notmuch_database_needs_upgrade (notmuch_database_t *database); + +-/* Upgrade the current database. ++/** ++ * Upgrade the current database. + * + * After opening a database in read-write mode, the client should + * check if an upgrade is needed (notmuch_database_needs_upgrade) and +@@ -277,7 +325,8 @@ notmuch_database_upgrade (notmuch_database_t *database, + double progress), + void *closure); + +-/* Begin an atomic database operation. ++/** ++ * Begin an atomic database operation. + * + * Any modifications performed between a successful begin and a + * notmuch_database_end_atomic will be applied to the database +@@ -298,7 +347,8 @@ notmuch_database_upgrade (notmuch_database_t *database, + notmuch_status_t + notmuch_database_begin_atomic (notmuch_database_t *notmuch); + +-/* Indicate the end of an atomic database operation. ++/** ++ * Indicate the end of an atomic database operation. + * + * Return value: + * +@@ -313,7 +363,8 @@ notmuch_database_begin_atomic (notmuch_database_t *notmuch); + notmuch_status_t + notmuch_database_end_atomic (notmuch_database_t *notmuch); + +-/* Retrieve a directory object from the database for 'path'. ++/** ++ * Retrieve a directory object from the database for 'path'. + * + * Here, 'path' should be a path relative to the path of 'database' + * (see notmuch_database_get_path), or else should be an absolute path +@@ -336,7 +387,8 @@ notmuch_database_get_directory (notmuch_database_t *database, + const char *path, + notmuch_directory_t **directory); + +-/* Add a new message to the given notmuch database or associate an ++/** ++ * Add a new message to the given notmuch database or associate an + * additional filename with an existing message. + * + * Here, 'filename' should be a path relative to the path of +@@ -387,7 +439,8 @@ notmuch_database_add_message (notmuch_database_t *database, + const char *filename, + notmuch_message_t **message); + +-/* Remove a message filename from the given notmuch database. If the ++/** ++ * Remove a message filename from the given notmuch database. If the + * message has no more filenames, remove the message. + * + * If the same message (as determined by the message ID) is still +@@ -415,7 +468,8 @@ notmuch_status_t + notmuch_database_remove_message (notmuch_database_t *database, + const char *filename); + +-/* Find a message with the given message_id. ++/** ++ * Find a message with the given message_id. + * + * If a message with the given message_id is found then, on successful return + * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message +@@ -442,7 +496,8 @@ notmuch_database_find_message (notmuch_database_t *database, + const char *message_id, + notmuch_message_t **message); + +-/* Find a message with the given filename. ++/** ++ * Find a message with the given filename. + * + * If the database contains a message with the given filename then, on + * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to +@@ -469,7 +524,8 @@ notmuch_database_find_message_by_filename (notmuch_database_t *notmuch, + const char *filename, + notmuch_message_t **message); + +-/* Return a list of all tags found in the database. ++/** ++ * Return a list of all tags found in the database. + * + * This function creates a list of all tags found in the database. The + * resulting list contains all tags from all messages found in the database. +@@ -479,7 +535,8 @@ notmuch_database_find_message_by_filename (notmuch_database_t *notmuch, + notmuch_tags_t * + notmuch_database_get_all_tags (notmuch_database_t *db); + +-/* Create a new query for 'database'. ++/** ++ * Create a new query for 'database'. + * + * Here, 'database' should be an open database, (see + * notmuch_database_open and notmuch_database_create). +@@ -507,19 +564,36 @@ notmuch_query_t * + notmuch_query_create (notmuch_database_t *database, + const char *query_string); + +-/* Sort values for notmuch_query_set_sort */ ++/** ++ * Sort values for notmuch_query_set_sort. ++ */ + typedef enum { ++ /** ++ * Oldest first. ++ */ + NOTMUCH_SORT_OLDEST_FIRST, ++ /** ++ * Newest first. ++ */ + NOTMUCH_SORT_NEWEST_FIRST, ++ /** ++ * Sort by message-id. ++ */ + NOTMUCH_SORT_MESSAGE_ID, ++ /** ++ * Do not sort. ++ */ + NOTMUCH_SORT_UNSORTED + } notmuch_sort_t; + +-/* Return the query_string of this query. See notmuch_query_create. */ ++/** ++ * Return the query_string of this query. See notmuch_query_create. ++ */ + const char * + notmuch_query_get_query_string (notmuch_query_t *query); + +-/* Exclude values for notmuch_query_set_omit_excluded. The strange ++/** ++ * Exclude values for notmuch_query_set_omit_excluded. The strange + * order is to maintain backward compatibility: the old FALSE/TRUE + * options correspond to the new + * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options. +@@ -531,7 +605,8 @@ typedef enum { + NOTMUCH_EXCLUDE_ALL + } notmuch_exclude_t; + +-/* Specify whether to omit excluded results or simply flag them. By ++/** ++ * Specify whether to omit excluded results or simply flag them. By + * default, this is set to TRUE. + * + * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded +@@ -561,21 +636,29 @@ void + notmuch_query_set_omit_excluded (notmuch_query_t *query, + notmuch_exclude_t omit_excluded); + +-/* Specify the sorting desired for this query. */ ++/** ++ * Specify the sorting desired for this query. ++ */ + void + notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort); + +-/* Return the sort specified for this query. See notmuch_query_set_sort. */ ++/** ++ * Return the sort specified for this query. See ++ * notmuch_query_set_sort. ++ */ + notmuch_sort_t + notmuch_query_get_sort (notmuch_query_t *query); + +-/* Add a tag that will be excluded from the query results by default. ++/** ++ * Add a tag that will be excluded from the query results by default. + * This exclusion will be overridden if this tag appears explicitly in +- * the query. */ ++ * the query. ++ */ + void + notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag); + +-/* Execute a query for threads, returning a notmuch_threads_t object ++/** ++ * Execute a query for threads, returning a notmuch_threads_t object + * which can be used to iterate over the results. The returned threads + * object is owned by the query and as such, will only be valid until + * notmuch_query_destroy. +@@ -616,7 +699,8 @@ notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag); + notmuch_threads_t * + notmuch_query_search_threads (notmuch_query_t *query); + +-/* Execute a query for messages, returning a notmuch_messages_t object ++/** ++ * Execute a query for messages, returning a notmuch_messages_t object + * which can be used to iterate over the results. The returned + * messages object is owned by the query and as such, will only be + * valid until notmuch_query_destroy. +@@ -657,7 +741,8 @@ notmuch_query_search_threads (notmuch_query_t *query); + notmuch_messages_t * + notmuch_query_search_messages (notmuch_query_t *query); + +-/* Destroy a notmuch_query_t along with any associated resources. ++/** ++ * Destroy a notmuch_query_t along with any associated resources. + * + * This will in turn destroy any notmuch_threads_t and + * notmuch_messages_t objects generated by this query, (and in +@@ -668,7 +753,8 @@ notmuch_query_search_messages (notmuch_query_t *query); + void + notmuch_query_destroy (notmuch_query_t *query); + +-/* Is the given 'threads' iterator pointing at a valid thread. ++/** ++ * Is the given 'threads' iterator pointing at a valid thread. + * + * When this function returns TRUE, notmuch_threads_get will return a + * valid object. Whereas when this function returns FALSE, +@@ -680,7 +766,8 @@ notmuch_query_destroy (notmuch_query_t *query); + notmuch_bool_t + notmuch_threads_valid (notmuch_threads_t *threads); + +-/* Get the current thread from 'threads' as a notmuch_thread_t. ++/** ++ * Get the current thread from 'threads' as a notmuch_thread_t. + * + * Note: The returned thread belongs to 'threads' and has a lifetime + * identical to it (and the query to which it belongs). +@@ -694,7 +781,8 @@ notmuch_threads_valid (notmuch_threads_t *threads); + notmuch_thread_t * + notmuch_threads_get (notmuch_threads_t *threads); + +-/* Move the 'threads' iterator to the next thread. ++/** ++ * Move the 'threads' iterator to the next thread. + * + * If 'threads' is already pointing at the last thread then the + * iterator will be moved to a point just beyond that last thread, +@@ -707,7 +795,8 @@ notmuch_threads_get (notmuch_threads_t *threads); + void + notmuch_threads_move_to_next (notmuch_threads_t *threads); + +-/* Destroy a notmuch_threads_t object. ++/** ++ * Destroy a notmuch_threads_t object. + * + * It's not strictly necessary to call this function. All memory from + * the notmuch_threads_t object will be reclaimed when the +@@ -716,7 +805,8 @@ notmuch_threads_move_to_next (notmuch_threads_t *threads); + void + notmuch_threads_destroy (notmuch_threads_t *threads); + +-/* Return an estimate of the number of messages matching a search ++/** ++ * Return an estimate of the number of messages matching a search. + * + * This function performs a search and returns Xapian's best + * guess as to number of matching messages. +@@ -726,8 +816,9 @@ notmuch_threads_destroy (notmuch_threads_t *threads); + */ + unsigned + notmuch_query_count_messages (notmuch_query_t *query); +- +-/* Return the number of threads matching a search. ++ ++/** ++ * Return the number of threads matching a search. + * + * This function performs a search and returns the number of unique thread IDs + * in the matching messages. This is the same as number of threads matching a +@@ -741,7 +832,8 @@ notmuch_query_count_messages (notmuch_query_t *query); + unsigned + notmuch_query_count_threads (notmuch_query_t *query); + +-/* Get the thread ID of 'thread'. ++/** ++ * Get the thread ID of 'thread'. + * + * The returned string belongs to 'thread' and as such, should not be + * modified by the caller and will only be valid for as long as the +@@ -751,7 +843,8 @@ notmuch_query_count_threads (notmuch_query_t *query); + const char * + notmuch_thread_get_thread_id (notmuch_thread_t *thread); + +-/* Get the total number of messages in 'thread'. ++/** ++ * Get the total number of messages in 'thread'. + * + * This count consists of all messages in the database belonging to + * this thread. Contrast with notmuch_thread_get_matched_messages() . +@@ -759,7 +852,8 @@ notmuch_thread_get_thread_id (notmuch_thread_t *thread); + int + notmuch_thread_get_total_messages (notmuch_thread_t *thread); + +-/* Get a notmuch_messages_t iterator for the top-level messages in ++/** ++ * Get a notmuch_messages_t iterator for the top-level messages in + * 'thread' in oldest-first order. + * + * This iterator will not necessarily iterate over all of the messages +@@ -769,13 +863,15 @@ notmuch_thread_get_total_messages (notmuch_thread_t *thread); + notmuch_messages_t * + 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. + */ + notmuch_messages_t * + notmuch_thread_get_messages (notmuch_thread_t *thread); + +-/* Get the number of messages in 'thread' that matched the search. ++/** ++ * Get the number of messages in 'thread' that matched the search. + * + * This count includes only the messages in this thread that were + * matched by the search from which the thread was created and were +@@ -786,7 +882,8 @@ notmuch_thread_get_messages (notmuch_thread_t *thread); + int + notmuch_thread_get_matched_messages (notmuch_thread_t *thread); + +-/* Get the authors of 'thread' as a UTF-8 string. ++/** ++ * Get the authors of 'thread' as a UTF-8 string. + * + * The returned string is a comma-separated list of the names of the + * authors of mail messages in the query results that belong to this +@@ -800,7 +897,8 @@ notmuch_thread_get_matched_messages (notmuch_thread_t *thread); + const char * + notmuch_thread_get_authors (notmuch_thread_t *thread); + +-/* Get the subject of 'thread' as a UTF-8 string. ++/** ++ * Get the subject of 'thread' as a UTF-8 string. + * + * The subject is taken from the first message (according to the query + * order---see notmuch_query_set_sort) in the query results that +@@ -814,17 +912,20 @@ notmuch_thread_get_authors (notmuch_thread_t *thread); + const char * + notmuch_thread_get_subject (notmuch_thread_t *thread); + +-/* Get the date of the oldest message in 'thread' as a time_t value. ++/** ++ * Get the date of the oldest message in 'thread' as a time_t value. + */ + time_t + notmuch_thread_get_oldest_date (notmuch_thread_t *thread); + +-/* Get the date of the newest message in 'thread' as a time_t value. ++/** ++ * Get the date of the newest message in 'thread' as a time_t value. + */ + time_t + notmuch_thread_get_newest_date (notmuch_thread_t *thread); + +-/* Get the tags for 'thread', returning a notmuch_tags_t object which ++/** ++ * Get the tags for 'thread', returning a notmuch_tags_t object which + * can be used to iterate over all tags. + * + * Note: In the Notmuch database, tags are stored on individual +@@ -863,11 +964,14 @@ notmuch_thread_get_newest_date (notmuch_thread_t *thread); + notmuch_tags_t * + notmuch_thread_get_tags (notmuch_thread_t *thread); + +-/* Destroy a notmuch_thread_t object. */ ++/** ++ * Destroy a notmuch_thread_t object. ++ */ + void + notmuch_thread_destroy (notmuch_thread_t *thread); + +-/* Is the given 'messages' iterator pointing at a valid message. ++/** ++ * Is the given 'messages' iterator pointing at a valid message. + * + * When this function returns TRUE, notmuch_messages_get will return a + * valid object. Whereas when this function returns FALSE, +@@ -879,7 +983,8 @@ notmuch_thread_destroy (notmuch_thread_t *thread); + notmuch_bool_t + notmuch_messages_valid (notmuch_messages_t *messages); + +-/* Get the current message from 'messages' as a notmuch_message_t. ++/** ++ * Get the current message from 'messages' as a notmuch_message_t. + * + * Note: The returned message belongs to 'messages' and has a lifetime + * identical to it (and the query to which it belongs). +@@ -893,7 +998,8 @@ notmuch_messages_valid (notmuch_messages_t *messages); + notmuch_message_t * + notmuch_messages_get (notmuch_messages_t *messages); + +-/* Move the 'messages' iterator to the next message. ++/** ++ * Move the 'messages' iterator to the next message. + * + * If 'messages' is already pointing at the last message then the + * iterator will be moved to a point just beyond that last message, +@@ -906,7 +1012,8 @@ notmuch_messages_get (notmuch_messages_t *messages); + void + notmuch_messages_move_to_next (notmuch_messages_t *messages); + +-/* Destroy a notmuch_messages_t object. ++/** ++ * Destroy a notmuch_messages_t object. + * + * It's not strictly necessary to call this function. All memory from + * the notmuch_messages_t object will be reclaimed when the containing +@@ -915,7 +1022,8 @@ notmuch_messages_move_to_next (notmuch_messages_t *messages); + void + notmuch_messages_destroy (notmuch_messages_t *messages); + +-/* Return a list of tags from all messages. ++/** ++ * Return a list of tags from all messages. + * + * The resulting list is guaranteed not to contain duplicated tags. + * +@@ -930,7 +1038,8 @@ notmuch_messages_destroy (notmuch_messages_t *messages); + notmuch_tags_t * + notmuch_messages_collect_tags (notmuch_messages_t *messages); + +-/* Get the message ID of 'message'. ++/** ++ * Get the message ID of 'message'. + * + * The returned string belongs to 'message' and as such, should not be + * modified by the caller and will only be valid for as long as the +@@ -944,7 +1053,8 @@ notmuch_messages_collect_tags (notmuch_messages_t *messages); + const char * + notmuch_message_get_message_id (notmuch_message_t *message); + +-/* Get the thread ID of 'message'. ++/** ++ * Get the thread ID of 'message'. + * + * The returned string belongs to 'message' and as such, should not be + * modified by the caller and will only be valid for as long as the +@@ -958,7 +1068,8 @@ notmuch_message_get_message_id (notmuch_message_t *message); + const char * + notmuch_message_get_thread_id (notmuch_message_t *message); + +-/* Get a notmuch_messages_t iterator for all of the replies to ++/** ++ * Get a notmuch_messages_t iterator for all of the replies to + * 'message'. + * + * Note: This call only makes sense if 'message' was ultimately +@@ -978,7 +1089,8 @@ notmuch_message_get_thread_id (notmuch_message_t *message); + notmuch_messages_t * + notmuch_message_get_replies (notmuch_message_t *message); + +-/* Get a filename for the email corresponding to 'message'. ++/** ++ * Get a filename for the email corresponding to 'message'. + * + * The returned filename is an absolute filename, (the initial + * component will match notmuch_database_get_path() ). +@@ -996,7 +1108,8 @@ notmuch_message_get_replies (notmuch_message_t *message); + const char * + notmuch_message_get_filename (notmuch_message_t *message); + +-/* Get all filenames for the email corresponding to 'message'. ++/** ++ * Get all filenames for the email corresponding to 'message'. + * + * Returns a notmuch_filenames_t iterator listing all the filenames + * associated with 'message'. These files may not have identical +@@ -1008,31 +1121,40 @@ notmuch_message_get_filename (notmuch_message_t *message); + notmuch_filenames_t * + notmuch_message_get_filenames (notmuch_message_t *message); + +-/* Message flags */ ++/** ++ * Message flags. ++ */ + typedef enum _notmuch_message_flag { + NOTMUCH_MESSAGE_FLAG_MATCH, + NOTMUCH_MESSAGE_FLAG_EXCLUDED + } notmuch_message_flag_t; + +-/* Get a value of a flag for the email corresponding to 'message'. */ ++/** ++ * Get a value of a flag for the email corresponding to 'message'. ++ */ + notmuch_bool_t + notmuch_message_get_flag (notmuch_message_t *message, + notmuch_message_flag_t flag); + +-/* Set a value of a flag for the email corresponding to 'message'. */ ++/** ++ * Set a value of a flag for the email corresponding to 'message'. ++ */ + void + notmuch_message_set_flag (notmuch_message_t *message, + notmuch_message_flag_t flag, notmuch_bool_t value); + +-/* Get the date of 'message' as a time_t value. ++/** ++ * Get the date of 'message' as a time_t value. + * + * For the original textual representation of the Date header from the + * message call notmuch_message_get_header() with a header value of +- * "date". */ ++ * "date". ++ */ + time_t + notmuch_message_get_date (notmuch_message_t *message); + +-/* Get the value of the specified header from 'message' as a UTF-8 string. ++/** ++ * Get the value of the specified header from 'message' as a UTF-8 string. + * + * Common headers are stored in the database when the message is + * indexed and will be returned from the database. Other headers will +@@ -1050,7 +1172,8 @@ notmuch_message_get_date (notmuch_message_t *message); + const char * + notmuch_message_get_header (notmuch_message_t *message, const char *header); + +-/* Get the tags for 'message', returning a notmuch_tags_t object which ++/** ++ * Get the tags for 'message', returning a notmuch_tags_t object which + * can be used to iterate over all tags. + * + * The tags object is owned by the message and as such, will only be +@@ -1083,10 +1206,13 @@ notmuch_message_get_header (notmuch_message_t *message, const char *header); + notmuch_tags_t * + notmuch_message_get_tags (notmuch_message_t *message); + +-/* The longest possible tag value. */ ++/** ++ * The longest possible tag value. ++ */ + #define NOTMUCH_TAG_MAX 200 + +-/* Add a tag to the given message. ++/** ++ * Add a tag to the given message. + * + * Return value: + * +@@ -1103,7 +1229,8 @@ notmuch_message_get_tags (notmuch_message_t *message); + notmuch_status_t + notmuch_message_add_tag (notmuch_message_t *message, const char *tag); + +-/* Remove a tag from the given message. ++/** ++ * Remove a tag from the given message. + * + * Return value: + * +@@ -1120,7 +1247,8 @@ notmuch_message_add_tag (notmuch_message_t *message, const char *tag); + notmuch_status_t + notmuch_message_remove_tag (notmuch_message_t *message, const char *tag); + +-/* Remove all tags from the given message. ++/** ++ * Remove all tags from the given message. + * + * See notmuch_message_freeze for an example showing how to safely + * replace tag values. +@@ -1131,7 +1259,8 @@ notmuch_message_remove_tag (notmuch_message_t *message, const char *tag); + notmuch_status_t + notmuch_message_remove_all_tags (notmuch_message_t *message); + +-/* Add/remove tags according to maildir flags in the message filename(s) ++/** ++ * Add/remove tags according to maildir flags in the message filename(s). + * + * This function examines the filenames of 'message' for maildir + * flags, and adds or removes tags on 'message' as follows when these +@@ -1165,7 +1294,8 @@ notmuch_message_remove_all_tags (notmuch_message_t *message); + notmuch_status_t + notmuch_message_maildir_flags_to_tags (notmuch_message_t *message); + +-/* Rename message filename(s) to encode tags as maildir flags ++/** ++ * Rename message filename(s) to encode tags as maildir flags. + * + * Specifically, for each filename corresponding to this message: + * +@@ -1201,7 +1331,8 @@ notmuch_message_maildir_flags_to_tags (notmuch_message_t *message); + notmuch_status_t + notmuch_message_tags_to_maildir_flags (notmuch_message_t *message); + +-/* Freeze the current state of 'message' within the database. ++/** ++ * Freeze the current state of 'message' within the database. + * + * This means that changes to the message state, (via + * notmuch_message_add_tag, notmuch_message_remove_tag, and +@@ -1244,7 +1375,8 @@ notmuch_message_tags_to_maildir_flags (notmuch_message_t *message); + notmuch_status_t + notmuch_message_freeze (notmuch_message_t *message); + +-/* Thaw the current 'message', synchronizing any changes that may have ++/** ++ * Thaw the current 'message', synchronizing any changes that may have + * occurred while 'message' was frozen into the notmuch database. + * + * See notmuch_message_freeze for an example of how to use this +@@ -1267,7 +1399,8 @@ notmuch_message_freeze (notmuch_message_t *message); + notmuch_status_t + notmuch_message_thaw (notmuch_message_t *message); + +-/* Destroy a notmuch_message_t object. ++/** ++ * Destroy a notmuch_message_t object. + * + * It can be useful to call this function in the case of a single + * query object with many messages in the result, (such as iterating +@@ -1278,7 +1411,8 @@ notmuch_message_thaw (notmuch_message_t *message); + void + notmuch_message_destroy (notmuch_message_t *message); + +-/* Is the given 'tags' iterator pointing at a valid tag. ++/** ++ * Is the given 'tags' iterator pointing at a valid tag. + * + * When this function returns TRUE, notmuch_tags_get will return a + * valid string. Whereas when this function returns FALSE, +@@ -1290,7 +1424,8 @@ notmuch_message_destroy (notmuch_message_t *message); + notmuch_bool_t + notmuch_tags_valid (notmuch_tags_t *tags); + +-/* Get the current tag from 'tags' as a string. ++/** ++ * Get the current tag from 'tags' as a string. + * + * Note: The returned string belongs to 'tags' and has a lifetime + * identical to it (and the query to which it ultimately belongs). +@@ -1301,7 +1436,8 @@ notmuch_tags_valid (notmuch_tags_t *tags); + const char * + notmuch_tags_get (notmuch_tags_t *tags); + +-/* Move the 'tags' iterator to the next tag. ++/** ++ * Move the 'tags' iterator to the next tag. + * + * If 'tags' is already pointing at the last tag then the iterator + * will be moved to a point just beyond that last tag, (where +@@ -1314,7 +1450,8 @@ notmuch_tags_get (notmuch_tags_t *tags); + void + notmuch_tags_move_to_next (notmuch_tags_t *tags); + +-/* Destroy a notmuch_tags_t object. ++/** ++ * Destroy a notmuch_tags_t object. + * + * It's not strictly necessary to call this function. All memory from + * the notmuch_tags_t object will be reclaimed when the containing +@@ -1323,7 +1460,8 @@ notmuch_tags_move_to_next (notmuch_tags_t *tags); + void + notmuch_tags_destroy (notmuch_tags_t *tags); + +-/* Store an mtime within the database for 'directory'. ++/** ++ * Store an mtime within the database for 'directory'. + * + * The 'directory' should be an object retrieved from the database + * with notmuch_database_get_directory for a particular path. +@@ -1363,35 +1501,44 @@ notmuch_status_t + notmuch_directory_set_mtime (notmuch_directory_t *directory, + time_t mtime); + +-/* Get the mtime of a directory, (as previously stored with ++/** ++ * Get the mtime of a directory, (as previously stored with + * notmuch_directory_set_mtime). + * + * Returns 0 if no mtime has previously been stored for this +- * directory.*/ ++ * directory. ++ */ + time_t + notmuch_directory_get_mtime (notmuch_directory_t *directory); + +-/* Get a notmuch_filenames_t iterator listing all the filenames of ++/** ++ * Get a notmuch_filenames_t iterator listing all the filenames of + * messages in the database within the given directory. + * + * The returned filenames will be the basename-entries only (not +- * complete paths). */ ++ * complete paths). ++ */ + notmuch_filenames_t * + notmuch_directory_get_child_files (notmuch_directory_t *directory); + +-/* Get a notmuch_filenams_t iterator listing all the filenames of ++/** ++ * Get a notmuch_filenams_t iterator listing all the filenames of + * sub-directories in the database within the given directory. + * + * The returned filenames will be the basename-entries only (not +- * complete paths). */ ++ * complete paths). ++ */ + notmuch_filenames_t * + notmuch_directory_get_child_directories (notmuch_directory_t *directory); + +-/* Destroy a notmuch_directory_t object. */ ++/** ++ * Destroy a notmuch_directory_t object. ++ */ + void + notmuch_directory_destroy (notmuch_directory_t *directory); + +-/* Is the given 'filenames' iterator pointing at a valid filename. ++/** ++ * Is the given 'filenames' iterator pointing at a valid filename. + * + * When this function returns TRUE, notmuch_filenames_get will return + * a valid string. Whereas when this function returns FALSE, +@@ -1403,7 +1550,8 @@ notmuch_directory_destroy (notmuch_directory_t *directory); + notmuch_bool_t + notmuch_filenames_valid (notmuch_filenames_t *filenames); + +-/* Get the current filename from 'filenames' as a string. ++/** ++ * Get the current filename from 'filenames' as a string. + * + * Note: The returned string belongs to 'filenames' and has a lifetime + * identical to it (and the directory to which it ultimately belongs). +@@ -1414,7 +1562,8 @@ notmuch_filenames_valid (notmuch_filenames_t *filenames); + const char * + notmuch_filenames_get (notmuch_filenames_t *filenames); + +-/* Move the 'filenames' iterator to the next filename. ++/** ++ * Move the 'filenames' iterator to the next filename. + * + * If 'filenames' is already pointing at the last filename then the + * iterator will be moved to a point just beyond that last filename, +@@ -1427,7 +1576,8 @@ notmuch_filenames_get (notmuch_filenames_t *filenames); + void + notmuch_filenames_move_to_next (notmuch_filenames_t *filenames); + +-/* Destroy a notmuch_filenames_t object. ++/** ++ * Destroy a notmuch_filenames_t object. + * + * It's not strictly necessary to call this function. All memory from + * the notmuch_filenames_t object will be reclaimed when the +@@ -1439,6 +1589,8 @@ notmuch_filenames_move_to_next (notmuch_filenames_t *filenames); + void + notmuch_filenames_destroy (notmuch_filenames_t *filenames); + ++/* @} */ ++ + NOTMUCH_END_DECLS + + #endif +-- +1.8.4.rc3 +