--- /dev/null
+Return-Path: <jani@nikula.org>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by olra.theworths.org (Postfix) with ESMTP id 46BFD431E64\r
+ for <notmuch@notmuchmail.org>; Wed, 1 Jan 2014 09:53:13 -0800 (PST)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References"\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.7\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.7 tagged_above=-999 required=5\r
+ tests=[RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+ by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id b2zKK7Aj7zNx for <notmuch@notmuchmail.org>;\r
+ Wed, 1 Jan 2014 09:53:06 -0800 (PST)\r
+Received: from mail-ee0-f46.google.com (mail-ee0-f46.google.com\r
+ [74.125.83.46]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client\r
+ certificate requested) by olra.theworths.org (Postfix) with ESMTPS id\r
+ 9265B431FC2 for <notmuch@notmuchmail.org>; Wed, 1 Jan 2014 09:53:05 -0800\r
+ (PST)\r
+Received: by mail-ee0-f46.google.com with SMTP id d49so5926980eek.33\r
+ for <notmuch@notmuchmail.org>; Wed, 01 Jan 2014 09:53:04 -0800 (PST)\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+ d=1e100.net; s=20130820;\r
+ h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to\r
+ :references:in-reply-to:references;\r
+ bh=ywwefm3SQKiFcZl9LQVCMu2zK9G/Xn/RLSqmzSfbxo8=;\r
+ b=F7aFIerrWnScjqOoVpyeK+c1E+mL0BENMeWTdKD+FXxuKs33CfHwXO1nfLGYXrDrLW\r
+ XfPoxuK2AjFFk0uzSoODXcQDpTTQI3WHZMtlmigbRD09Z4pR1Yn+wS5qcPtOr7X/pOn/\r
+ L6FJhwgK1KWWQSS2li0psdwu6nT9t24aOqQaIEcJIN9HJhjoJKr/qXE+qRg1Lxf2uL3z\r
+ AXOtANRmg5+9If+PtzyaamDfAnzKG+8ZjtHJGdl4EoXBjtPrEJLmfCqWTOhbUr7NKpoU\r
+ O3KXBE3wnDaAWWMGEW7wNdS9Y5VKYvvDHRuA1pTyduSUKz5Be4cYPAzCzCOE0o51ekWT\r
+ /28A==\r
+X-Gm-Message-State:\r
+ ALoCoQmMqC5JzPtFipk0mka1fmxHY6Hy0IL0nCYWaDnrLx5zWC+/Ryao5IhkrZGjtVZbobTtzaGx\r
+X-Received: by 10.14.102.69 with SMTP id c45mr464772eeg.114.1388598784342;\r
+ Wed, 01 Jan 2014 09:53:04 -0800 (PST)\r
+Received: from localhost (dsl-hkibrasgw2-58c36f-91.dhcp.inet.fi.\r
+ [88.195.111.91]) by mx.google.com with ESMTPSA id\r
+ z42sm128862077eeo.17.2014.01.01.09.53.00 for <multiple recipients>\r
+ (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\r
+ Wed, 01 Jan 2014 09:53:03 -0800 (PST)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v2 2/2] lib: modify notmuch.h for automatic document\r
+ generation\r
+Date: Wed, 1 Jan 2014 19:52:54 +0200\r
+Message-Id:\r
+ <1f7313155c44668635b6c23799c2a95f93dcc52f.1388598677.git.jani@nikula.org>\r
+X-Mailer: git-send-email 1.8.5.2\r
+In-Reply-To: <cover.1388598677.git.jani@nikula.org>\r
+References: <cover.1388598677.git.jani@nikula.org>\r
+In-Reply-To: <cover.1388598677.git.jani@nikula.org>\r
+References: <cover.1388598677.git.jani@nikula.org>\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Wed, 01 Jan 2014 17:53:13 -0000\r
+\r
+Minimal changes to produce a sensible result.\r
+---\r
+ lib/notmuch.h | 443 +++++++++++++++++++++++++++++++++++++++-------------------\r
+ 1 file changed, 302 insertions(+), 141 deletions(-)\r
+\r
+diff --git a/lib/notmuch.h b/lib/notmuch.h\r
+index d30768d..02604c5 100644\r
+--- a/lib/notmuch.h\r
++++ b/lib/notmuch.h\r
+@@ -18,9 +18,19 @@\r
+ * Author: Carl Worth <cworth@cworth.org>\r
+ */\r
+ \r
++/**\r
++ * @defgroup notmuch The notmuch API\r
++ *\r
++ * Not much of an email library, (just index and search)\r
++ *\r
++ * @{\r
++ */\r
++\r
+ #ifndef NOTMUCH_H\r
+ #define NOTMUCH_H\r
+ \r
++#ifndef __DOXYGEN__\r
++\r
+ #ifdef __cplusplus\r
+ # define NOTMUCH_BEGIN_DECLS extern "C" {\r
+ # define NOTMUCH_END_DECLS }\r
+@@ -49,19 +59,28 @@ NOTMUCH_BEGIN_DECLS\r
+ #define LIBNOTMUCH_MINOR_VERSION 1\r
+ #define LIBNOTMUCH_MICRO_VERSION 0\r
+ \r
+-/*\r
++#endif /* __DOXYGEN__ */\r
++\r
++/**\r
+ * Check the version of the notmuch library being compiled against.\r
+ *\r
+ * Return true if the library being compiled against is of the\r
+ * specified version or above. For example:\r
+ *\r
++ * @code\r
+ * #if LIBNOTMUCH_CHECK_VERSION(3, 1, 0)\r
+ * (code requiring libnotmuch 3.1.0 or above)\r
+ * #endif\r
++ * @endcode\r
++ *\r
++ * LIBNOTMUCH_CHECK_VERSION has been defined since version 3.1.0; to\r
++ * check for versions prior to that, use:\r
+ *\r
+- * LIBNOTMUCH_CHECK_VERSION has been defined since version 3.1.0; you\r
+- * can use #if !defined(NOTMUCH_CHECK_VERSION) to check for versions\r
+- * prior to that.\r
++ * @code\r
++ * #if !defined(NOTMUCH_CHECK_VERSION)\r
++ * (code requiring libnotmuch prior to 3.1.0)\r
++ * #endif\r
++ * @endcode\r
+ */\r
+ #define LIBNOTMUCH_CHECK_VERSION (major, minor, micro) \\r
+ (LIBNOTMUCH_MAJOR_VERSION > (major) || \\r
+@@ -69,72 +88,86 @@ NOTMUCH_BEGIN_DECLS\r
+ (LIBNOTMUCH_MAJOR_VERSION == (major) && LIBNOTMUCH_MINOR_VERSION == (minor) && \\r
+ LIBNOTMUCH_MICRO_VERSION >= (micro)))\r
+ \r
++/**\r
++ * Notmuch boolean type.\r
++ */\r
+ typedef int notmuch_bool_t;\r
+ \r
+-/* Status codes used for the return values of most functions.\r
++/**\r
++ * Status codes used for the return values of most functions.\r
+ *\r
+ * A zero value (NOTMUCH_STATUS_SUCCESS) indicates that the function\r
+- * completed without error. Any other value indicates an error as\r
+- * follows:\r
+- *\r
+- * NOTMUCH_STATUS_SUCCESS: No error occurred.\r
+- *\r
+- * NOTMUCH_STATUS_OUT_OF_MEMORY: Out of memory\r
+- *\r
+- * XXX: We don't really want to expose this lame XAPIAN_EXCEPTION\r
+- * value. Instead we should map to things like DATABASE_LOCKED or\r
+- * whatever.\r
+- *\r
+- * NOTMUCH_STATUS_READ_ONLY_DATABASE: An attempt was made to write to\r
+- * a database opened in read-only mode.\r
+- *\r
+- * NOTMUCH_STATUS_XAPIAN_EXCEPTION: A Xapian exception occurred\r
+- *\r
+- * NOTMUCH_STATUS_FILE_ERROR: An error occurred trying to read or\r
+- * write to a file (this could be file not found, permission\r
+- * denied, etc.)\r
+- *\r
+- * NOTMUCH_STATUS_FILE_NOT_EMAIL: A file was presented that doesn't\r
+- * appear to be an email message.\r
+- *\r
+- * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID: A file contains a message ID\r
+- * that is identical to a message already in the database.\r
+- *\r
+- * NOTMUCH_STATUS_NULL_POINTER: The user erroneously passed a NULL\r
+- * pointer to a notmuch function.\r
+- *\r
+- * NOTMUCH_STATUS_TAG_TOO_LONG: A tag value is too long (exceeds\r
+- * NOTMUCH_TAG_MAX)\r
+- *\r
+- * NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW: The notmuch_message_thaw\r
+- * function has been called more times than notmuch_message_freeze.\r
+- *\r
+- * NOTMUCH_STATUS_UNBALANCED_ATOMIC: notmuch_database_end_atomic has\r
+- * been called more times than notmuch_database_begin_atomic.\r
+- *\r
+- * And finally:\r
+- *\r
+- * NOTMUCH_STATUS_LAST_STATUS: Not an actual status value. Just a way\r
+- * to find out how many valid status values there are.\r
++ * completed without error. Any other value indicates an error.\r
+ */\r
+ typedef enum _notmuch_status {\r
++ /**\r
++ * No error occurred.\r
++ */\r
+ NOTMUCH_STATUS_SUCCESS = 0,\r
++ /**\r
++ * Out of memory.\r
++ */\r
+ NOTMUCH_STATUS_OUT_OF_MEMORY,\r
++ /**\r
++ * An attempt was made to write to a database opened in read-only\r
++ * mode.\r
++ */\r
+ NOTMUCH_STATUS_READ_ONLY_DATABASE,\r
++ /**\r
++ * A Xapian exception occurred.\r
++ */\r
+ NOTMUCH_STATUS_XAPIAN_EXCEPTION,\r
++ /**\r
++ * An error occurred trying to read or write to a file (this could\r
++ * be file not found, permission denied, etc.)\r
++ *\r
++ * @todo We don't really want to expose this lame XAPIAN_EXCEPTION\r
++ * value. Instead we should map to things like DATABASE_LOCKED or\r
++ * whatever.\r
++ */\r
+ NOTMUCH_STATUS_FILE_ERROR,\r
++ /**\r
++ * A file was presented that doesn't appear to be an email\r
++ * message.\r
++ */\r
+ NOTMUCH_STATUS_FILE_NOT_EMAIL,\r
++ /**\r
++ * A file contains a message ID that is identical to a message\r
++ * already in the database.\r
++ */\r
+ NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID,\r
++ /**\r
++ * The user erroneously passed a NULL pointer to a notmuch\r
++ * function.\r
++ */\r
+ NOTMUCH_STATUS_NULL_POINTER,\r
++ /**\r
++ * A tag value is too long (exceeds NOTMUCH_TAG_MAX).\r
++ */\r
+ NOTMUCH_STATUS_TAG_TOO_LONG,\r
++ /**\r
++ * The notmuch_message_thaw function has been called more times\r
++ * than notmuch_message_freeze.\r
++ */\r
+ NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW,\r
++ /**\r
++ * notmuch_database_end_atomic has been called more times than\r
++ * notmuch_database_begin_atomic.\r
++ */\r
+ NOTMUCH_STATUS_UNBALANCED_ATOMIC,\r
++ /**\r
++ * The operation is not supported.\r
++ */\r
+ NOTMUCH_STATUS_UNSUPPORTED_OPERATION,\r
+-\r
++ /**\r
++ * Not an actual status value. Just a way to find out how many\r
++ * valid status values there are.\r
++ */\r
+ NOTMUCH_STATUS_LAST_STATUS\r
+ } notmuch_status_t;\r
+ \r
+-/* Get a string representation of a notmuch_status_t value.\r
++/**\r
++ * Get a string representation of a notmuch_status_t value.\r
+ *\r
+ * The result is read-only.\r
+ */\r
+@@ -143,6 +176,7 @@ notmuch_status_to_string (notmuch_status_t status);\r
+ \r
+ /* Various opaque data types. For each notmuch_<foo>_t see the various\r
+ * notmuch_<foo> functions below. */\r
++#ifndef __DOXYGEN__\r
+ typedef struct _notmuch_database notmuch_database_t;\r
+ typedef struct _notmuch_query notmuch_query_t;\r
+ typedef struct _notmuch_threads notmuch_threads_t;\r
+@@ -152,8 +186,10 @@ typedef struct _notmuch_message notmuch_message_t;\r
+ typedef struct _notmuch_tags notmuch_tags_t;\r
+ typedef struct _notmuch_directory notmuch_directory_t;\r
+ typedef struct _notmuch_filenames notmuch_filenames_t;\r
++#endif /* __DOXYGEN__ */\r
+ \r
+-/* Create a new, empty notmuch database located at 'path'.\r
++/**\r
++ * Create a new, empty notmuch database located at 'path'.\r
+ *\r
+ * The path should be a top-level directory to a collection of\r
+ * plain-text email messages (one message per file). This call will\r
+@@ -189,12 +225,22 @@ typedef struct _notmuch_filenames notmuch_filenames_t;\r
+ notmuch_status_t\r
+ notmuch_database_create (const char *path, notmuch_database_t **database);\r
+ \r
++/**\r
++ * Database open mode for notmuch_database_open.\r
++ */\r
+ typedef enum {\r
++ /**\r
++ * Open database for reading only.\r
++ */\r
+ NOTMUCH_DATABASE_MODE_READ_ONLY = 0,\r
++ /**\r
++ * Open database for reading and writing.\r
++ */\r
+ NOTMUCH_DATABASE_MODE_READ_WRITE\r
+ } notmuch_database_mode_t;\r
+ \r
+-/* Open an existing notmuch database located at 'path'.\r
++/**\r
++ * Open an existing notmuch database located at 'path'.\r
+ *\r
+ * The database should have been created at some time in the past,\r
+ * (not necessarily by this process), by calling\r
+@@ -230,7 +276,8 @@ notmuch_database_open (const char *path,\r
+ notmuch_database_mode_t mode,\r
+ notmuch_database_t **database);\r
+ \r
+-/* Close the given notmuch database.\r
++/**\r
++ * Close the given notmuch database.\r
+ *\r
+ * After notmuch_database_close has been called, calls to other\r
+ * functions on objects derived from this database may either behave\r
+@@ -244,12 +291,14 @@ notmuch_database_open (const char *path,\r
+ void\r
+ notmuch_database_close (notmuch_database_t *database);\r
+ \r
+-/* A callback invoked by notmuch_database_compact to notify the user\r
++/**\r
++ * A callback invoked by notmuch_database_compact to notify the user\r
+ * of the progress of the compaction process.\r
+ */\r
+ typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure);\r
+ \r
+-/* Compact a notmuch database, backing up the original database to the\r
++/**\r
++ * Compact a notmuch database, backing up the original database to the\r
+ * given path.\r
+ *\r
+ * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE\r
+@@ -265,33 +314,41 @@ notmuch_database_compact (const char* path,\r
+ notmuch_compact_status_cb_t status_cb,\r
+ void *closure);\r
+ \r
+-/* Destroy the notmuch database, closing it if necessary and freeing\r
++/**\r
++ * Destroy the notmuch database, closing it if necessary and freeing\r
+ * all associated resources.\r
+ */\r
+ void\r
+ notmuch_database_destroy (notmuch_database_t *database);\r
+ \r
+-/* Return the database path of the given database.\r
++/**\r
++ * Return the database path of the given database.\r
+ *\r
+ * The return value is a string owned by notmuch so should not be\r
+- * modified nor freed by the caller. */\r
++ * modified nor freed by the caller.\r
++ */\r
+ const char *\r
+ notmuch_database_get_path (notmuch_database_t *database);\r
+ \r
+-/* Return the database format version of the given database. */\r
++/**\r
++ * Return the database format version of the given database.\r
++ */\r
+ unsigned int\r
+ notmuch_database_get_version (notmuch_database_t *database);\r
+ \r
+-/* Does this database need to be upgraded before writing to it?\r
++/**\r
++ * Does this database need to be upgraded before writing to it?\r
+ *\r
+ * If this function returns TRUE then no functions that modify the\r
+ * database (notmuch_database_add_message, notmuch_message_add_tag,\r
+ * notmuch_directory_set_mtime, etc.) will work unless the function\r
+- * notmuch_database_upgrade is called successfully first. */\r
++ * notmuch_database_upgrade is called successfully first.\r
++ */\r
+ notmuch_bool_t\r
+ notmuch_database_needs_upgrade (notmuch_database_t *database);\r
+ \r
+-/* Upgrade the current database.\r
++/**\r
++ * Upgrade the current database.\r
+ *\r
+ * After opening a database in read-write mode, the client should\r
+ * check if an upgrade is needed (notmuch_database_needs_upgrade) and\r
+@@ -310,7 +367,8 @@ notmuch_database_upgrade (notmuch_database_t *database,\r
+ double progress),\r
+ void *closure);\r
+ \r
+-/* Begin an atomic database operation.\r
++/**\r
++ * Begin an atomic database operation.\r
+ *\r
+ * Any modifications performed between a successful begin and a\r
+ * notmuch_database_end_atomic will be applied to the database\r
+@@ -331,7 +389,8 @@ notmuch_database_upgrade (notmuch_database_t *database,\r
+ notmuch_status_t\r
+ notmuch_database_begin_atomic (notmuch_database_t *notmuch);\r
+ \r
+-/* Indicate the end of an atomic database operation.\r
++/**\r
++ * Indicate the end of an atomic database operation.\r
+ *\r
+ * Return value:\r
+ *\r
+@@ -346,7 +405,8 @@ notmuch_database_begin_atomic (notmuch_database_t *notmuch);\r
+ notmuch_status_t\r
+ notmuch_database_end_atomic (notmuch_database_t *notmuch);\r
+ \r
+-/* Retrieve a directory object from the database for 'path'.\r
++/**\r
++ * Retrieve a directory object from the database for 'path'.\r
+ *\r
+ * Here, 'path' should be a path relative to the path of 'database'\r
+ * (see notmuch_database_get_path), or else should be an absolute path\r
+@@ -369,7 +429,8 @@ notmuch_database_get_directory (notmuch_database_t *database,\r
+ const char *path,\r
+ notmuch_directory_t **directory);\r
+ \r
+-/* Add a new message to the given notmuch database or associate an\r
++/**\r
++ * Add a new message to the given notmuch database or associate an\r
+ * additional filename with an existing message.\r
+ *\r
+ * Here, 'filename' should be a path relative to the path of\r
+@@ -420,7 +481,8 @@ notmuch_database_add_message (notmuch_database_t *database,\r
+ const char *filename,\r
+ notmuch_message_t **message);\r
+ \r
+-/* Remove a message filename from the given notmuch database. If the\r
++/**\r
++ * Remove a message filename from the given notmuch database. If the\r
+ * message has no more filenames, remove the message.\r
+ *\r
+ * If the same message (as determined by the message ID) is still\r
+@@ -448,7 +510,8 @@ notmuch_status_t\r
+ notmuch_database_remove_message (notmuch_database_t *database,\r
+ const char *filename);\r
+ \r
+-/* Find a message with the given message_id.\r
++/**\r
++ * Find a message with the given message_id.\r
+ *\r
+ * If a message with the given message_id is found then, on successful return\r
+ * (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to a message\r
+@@ -475,7 +538,8 @@ notmuch_database_find_message (notmuch_database_t *database,\r
+ const char *message_id,\r
+ notmuch_message_t **message);\r
+ \r
+-/* Find a message with the given filename.\r
++/**\r
++ * Find a message with the given filename.\r
+ *\r
+ * If the database contains a message with the given filename then, on\r
+ * successful return (NOTMUCH_STATUS_SUCCESS) '*message' will be initialized to\r
+@@ -502,7 +566,8 @@ notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,\r
+ const char *filename,\r
+ notmuch_message_t **message);\r
+ \r
+-/* Return a list of all tags found in the database.\r
++/**\r
++ * Return a list of all tags found in the database.\r
+ *\r
+ * This function creates a list of all tags found in the database. The\r
+ * resulting list contains all tags from all messages found in the database.\r
+@@ -512,7 +577,8 @@ notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,\r
+ notmuch_tags_t *\r
+ notmuch_database_get_all_tags (notmuch_database_t *db);\r
+ \r
+-/* Create a new query for 'database'.\r
++/**\r
++ * Create a new query for 'database'.\r
+ *\r
+ * Here, 'database' should be an open database, (see\r
+ * notmuch_database_open and notmuch_database_create).\r
+@@ -540,19 +606,36 @@ notmuch_query_t *\r
+ notmuch_query_create (notmuch_database_t *database,\r
+ const char *query_string);\r
+ \r
+-/* Sort values for notmuch_query_set_sort */\r
++/**\r
++ * Sort values for notmuch_query_set_sort.\r
++ */\r
+ typedef enum {\r
++ /**\r
++ * Oldest first.\r
++ */\r
+ NOTMUCH_SORT_OLDEST_FIRST,\r
++ /**\r
++ * Newest first.\r
++ */\r
+ NOTMUCH_SORT_NEWEST_FIRST,\r
++ /**\r
++ * Sort by message-id.\r
++ */\r
+ NOTMUCH_SORT_MESSAGE_ID,\r
++ /**\r
++ * Do not sort.\r
++ */\r
+ NOTMUCH_SORT_UNSORTED\r
+ } notmuch_sort_t;\r
+ \r
+-/* Return the query_string of this query. See notmuch_query_create. */\r
++/**\r
++ * Return the query_string of this query. See notmuch_query_create.\r
++ */\r
+ const char *\r
+ notmuch_query_get_query_string (notmuch_query_t *query);\r
+ \r
+-/* Exclude values for notmuch_query_set_omit_excluded. The strange\r
++/**\r
++ * Exclude values for notmuch_query_set_omit_excluded. The strange\r
+ * order is to maintain backward compatibility: the old FALSE/TRUE\r
+ * options correspond to the new\r
+ * NOTMUCH_EXCLUDE_FLAG/NOTMUCH_EXCLUDE_TRUE options.\r
+@@ -564,7 +647,8 @@ typedef enum {\r
+ NOTMUCH_EXCLUDE_ALL\r
+ } notmuch_exclude_t;\r
+ \r
+-/* Specify whether to omit excluded results or simply flag them. By\r
++/**\r
++ * Specify whether to omit excluded results or simply flag them. By\r
+ * default, this is set to TRUE.\r
+ *\r
+ * If set to TRUE or ALL, notmuch_query_search_messages will omit excluded\r
+@@ -594,21 +678,29 @@ void\r
+ notmuch_query_set_omit_excluded (notmuch_query_t *query,\r
+ notmuch_exclude_t omit_excluded);\r
+ \r
+-/* Specify the sorting desired for this query. */\r
++/**\r
++ * Specify the sorting desired for this query.\r
++ */\r
+ void\r
+ notmuch_query_set_sort (notmuch_query_t *query, notmuch_sort_t sort);\r
+ \r
+-/* Return the sort specified for this query. See notmuch_query_set_sort. */\r
++/**\r
++ * Return the sort specified for this query. See\r
++ * notmuch_query_set_sort.\r
++ */\r
+ notmuch_sort_t\r
+ notmuch_query_get_sort (notmuch_query_t *query);\r
+ \r
+-/* Add a tag that will be excluded from the query results by default.\r
++/**\r
++ * Add a tag that will be excluded from the query results by default.\r
+ * This exclusion will be overridden if this tag appears explicitly in\r
+- * the query. */\r
++ * the query.\r
++ */\r
+ void\r
+ notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);\r
+ \r
+-/* Execute a query for threads, returning a notmuch_threads_t object\r
++/**\r
++ * Execute a query for threads, returning a notmuch_threads_t object\r
+ * which can be used to iterate over the results. The returned threads\r
+ * object is owned by the query and as such, will only be valid until\r
+ * notmuch_query_destroy.\r
+@@ -649,7 +741,8 @@ notmuch_query_add_tag_exclude (notmuch_query_t *query, const char *tag);\r
+ notmuch_threads_t *\r
+ notmuch_query_search_threads (notmuch_query_t *query);\r
+ \r
+-/* Execute a query for messages, returning a notmuch_messages_t object\r
++/**\r
++ * Execute a query for messages, returning a notmuch_messages_t object\r
+ * which can be used to iterate over the results. The returned\r
+ * messages object is owned by the query and as such, will only be\r
+ * valid until notmuch_query_destroy.\r
+@@ -690,7 +783,8 @@ notmuch_query_search_threads (notmuch_query_t *query);\r
+ notmuch_messages_t *\r
+ notmuch_query_search_messages (notmuch_query_t *query);\r
+ \r
+-/* Destroy a notmuch_query_t along with any associated resources.\r
++/**\r
++ * Destroy a notmuch_query_t along with any associated resources.\r
+ *\r
+ * This will in turn destroy any notmuch_threads_t and\r
+ * notmuch_messages_t objects generated by this query, (and in\r
+@@ -701,7 +795,8 @@ notmuch_query_search_messages (notmuch_query_t *query);\r
+ void\r
+ notmuch_query_destroy (notmuch_query_t *query);\r
+ \r
+-/* Is the given 'threads' iterator pointing at a valid thread.\r
++/**\r
++ * Is the given 'threads' iterator pointing at a valid thread.\r
+ *\r
+ * When this function returns TRUE, notmuch_threads_get will return a\r
+ * valid object. Whereas when this function returns FALSE,\r
+@@ -713,7 +808,8 @@ notmuch_query_destroy (notmuch_query_t *query);\r
+ notmuch_bool_t\r
+ notmuch_threads_valid (notmuch_threads_t *threads);\r
+ \r
+-/* Get the current thread from 'threads' as a notmuch_thread_t.\r
++/**\r
++ * Get the current thread from 'threads' as a notmuch_thread_t.\r
+ *\r
+ * Note: The returned thread belongs to 'threads' and has a lifetime\r
+ * identical to it (and the query to which it belongs).\r
+@@ -727,7 +823,8 @@ notmuch_threads_valid (notmuch_threads_t *threads);\r
+ notmuch_thread_t *\r
+ notmuch_threads_get (notmuch_threads_t *threads);\r
+ \r
+-/* Move the 'threads' iterator to the next thread.\r
++/**\r
++ * Move the 'threads' iterator to the next thread.\r
+ *\r
+ * If 'threads' is already pointing at the last thread then the\r
+ * iterator will be moved to a point just beyond that last thread,\r
+@@ -740,7 +837,8 @@ notmuch_threads_get (notmuch_threads_t *threads);\r
+ void\r
+ notmuch_threads_move_to_next (notmuch_threads_t *threads);\r
+ \r
+-/* Destroy a notmuch_threads_t object.\r
++/**\r
++ * Destroy a notmuch_threads_t object.\r
+ *\r
+ * It's not strictly necessary to call this function. All memory from\r
+ * the notmuch_threads_t object will be reclaimed when the\r
+@@ -749,7 +847,8 @@ notmuch_threads_move_to_next (notmuch_threads_t *threads);\r
+ void\r
+ notmuch_threads_destroy (notmuch_threads_t *threads);\r
+ \r
+-/* Return an estimate of the number of messages matching a search\r
++/**\r
++ * Return an estimate of the number of messages matching a search.\r
+ *\r
+ * This function performs a search and returns Xapian's best\r
+ * guess as to number of matching messages.\r
+@@ -759,8 +858,9 @@ notmuch_threads_destroy (notmuch_threads_t *threads);\r
+ */\r
+ unsigned\r
+ notmuch_query_count_messages (notmuch_query_t *query);\r
+- \r
+-/* Return the number of threads matching a search.\r
++\r
++/**\r
++ * Return the number of threads matching a search.\r
+ *\r
+ * This function performs a search and returns the number of unique thread IDs\r
+ * in the matching messages. This is the same as number of threads matching a\r
+@@ -774,7 +874,8 @@ notmuch_query_count_messages (notmuch_query_t *query);\r
+ unsigned\r
+ notmuch_query_count_threads (notmuch_query_t *query);\r
+ \r
+-/* Get the thread ID of 'thread'.\r
++/**\r
++ * Get the thread ID of 'thread'.\r
+ *\r
+ * The returned string belongs to 'thread' and as such, should not be\r
+ * modified by the caller and will only be valid for as long as the\r
+@@ -784,7 +885,8 @@ notmuch_query_count_threads (notmuch_query_t *query);\r
+ const char *\r
+ notmuch_thread_get_thread_id (notmuch_thread_t *thread);\r
+ \r
+-/* Get the total number of messages in 'thread'.\r
++/**\r
++ * Get the total number of messages in 'thread'.\r
+ *\r
+ * This count consists of all messages in the database belonging to\r
+ * this thread. Contrast with notmuch_thread_get_matched_messages() .\r
+@@ -792,7 +894,8 @@ notmuch_thread_get_thread_id (notmuch_thread_t *thread);\r
+ int\r
+ notmuch_thread_get_total_messages (notmuch_thread_t *thread);\r
+ \r
+-/* Get a notmuch_messages_t iterator for the top-level messages in\r
++/**\r
++ * Get a notmuch_messages_t iterator for the top-level messages in\r
+ * 'thread' in oldest-first order.\r
+ *\r
+ * This iterator will not necessarily iterate over all of the messages\r
+@@ -804,7 +907,8 @@ notmuch_thread_get_total_messages (notmuch_thread_t *thread);\r
+ notmuch_messages_t *\r
+ notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);\r
+ \r
+-/* Get a notmuch_thread_t iterator for all messages in 'thread' in\r
++/**\r
++ * Get a notmuch_thread_t iterator for all messages in 'thread' in\r
+ * oldest-first order.\r
+ *\r
+ * The returned list will be destroyed when the thread is destroyed.\r
+@@ -812,7 +916,8 @@ notmuch_thread_get_toplevel_messages (notmuch_thread_t *thread);\r
+ notmuch_messages_t *\r
+ notmuch_thread_get_messages (notmuch_thread_t *thread);\r
+ \r
+-/* Get the number of messages in 'thread' that matched the search.\r
++/**\r
++ * Get the number of messages in 'thread' that matched the search.\r
+ *\r
+ * This count includes only the messages in this thread that were\r
+ * matched by the search from which the thread was created and were\r
+@@ -823,7 +928,8 @@ notmuch_thread_get_messages (notmuch_thread_t *thread);\r
+ int\r
+ notmuch_thread_get_matched_messages (notmuch_thread_t *thread);\r
+ \r
+-/* Get the authors of 'thread' as a UTF-8 string.\r
++/**\r
++ * Get the authors of 'thread' as a UTF-8 string.\r
+ *\r
+ * The returned string is a comma-separated list of the names of the\r
+ * authors of mail messages in the query results that belong to this\r
+@@ -837,7 +943,8 @@ notmuch_thread_get_matched_messages (notmuch_thread_t *thread);\r
+ const char *\r
+ notmuch_thread_get_authors (notmuch_thread_t *thread);\r
+ \r
+-/* Get the subject of 'thread' as a UTF-8 string.\r
++/**\r
++ * Get the subject of 'thread' as a UTF-8 string.\r
+ *\r
+ * The subject is taken from the first message (according to the query\r
+ * order---see notmuch_query_set_sort) in the query results that\r
+@@ -851,17 +958,20 @@ notmuch_thread_get_authors (notmuch_thread_t *thread);\r
+ const char *\r
+ notmuch_thread_get_subject (notmuch_thread_t *thread);\r
+ \r
+-/* Get the date of the oldest message in 'thread' as a time_t value.\r
++/**\r
++ * Get the date of the oldest message in 'thread' as a time_t value.\r
+ */\r
+ time_t\r
+ notmuch_thread_get_oldest_date (notmuch_thread_t *thread);\r
+ \r
+-/* Get the date of the newest message in 'thread' as a time_t value.\r
++/**\r
++ * Get the date of the newest message in 'thread' as a time_t value.\r
+ */\r
+ time_t\r
+ notmuch_thread_get_newest_date (notmuch_thread_t *thread);\r
+ \r
+-/* Get the tags for 'thread', returning a notmuch_tags_t object which\r
++/**\r
++ * Get the tags for 'thread', returning a notmuch_tags_t object which\r
+ * can be used to iterate over all tags.\r
+ *\r
+ * Note: In the Notmuch database, tags are stored on individual\r
+@@ -900,11 +1010,14 @@ notmuch_thread_get_newest_date (notmuch_thread_t *thread);\r
+ notmuch_tags_t *\r
+ notmuch_thread_get_tags (notmuch_thread_t *thread);\r
+ \r
+-/* Destroy a notmuch_thread_t object. */\r
++/**\r
++ * Destroy a notmuch_thread_t object.\r
++ */\r
+ void\r
+ notmuch_thread_destroy (notmuch_thread_t *thread);\r
+ \r
+-/* Is the given 'messages' iterator pointing at a valid message.\r
++/**\r
++ * Is the given 'messages' iterator pointing at a valid message.\r
+ *\r
+ * When this function returns TRUE, notmuch_messages_get will return a\r
+ * valid object. Whereas when this function returns FALSE,\r
+@@ -916,7 +1029,8 @@ notmuch_thread_destroy (notmuch_thread_t *thread);\r
+ notmuch_bool_t\r
+ notmuch_messages_valid (notmuch_messages_t *messages);\r
+ \r
+-/* Get the current message from 'messages' as a notmuch_message_t.\r
++/**\r
++ * Get the current message from 'messages' as a notmuch_message_t.\r
+ *\r
+ * Note: The returned message belongs to 'messages' and has a lifetime\r
+ * identical to it (and the query to which it belongs).\r
+@@ -930,7 +1044,8 @@ notmuch_messages_valid (notmuch_messages_t *messages);\r
+ notmuch_message_t *\r
+ notmuch_messages_get (notmuch_messages_t *messages);\r
+ \r
+-/* Move the 'messages' iterator to the next message.\r
++/**\r
++ * Move the 'messages' iterator to the next message.\r
+ *\r
+ * If 'messages' is already pointing at the last message then the\r
+ * iterator will be moved to a point just beyond that last message,\r
+@@ -943,7 +1058,8 @@ notmuch_messages_get (notmuch_messages_t *messages);\r
+ void\r
+ notmuch_messages_move_to_next (notmuch_messages_t *messages);\r
+ \r
+-/* Destroy a notmuch_messages_t object.\r
++/**\r
++ * Destroy a notmuch_messages_t object.\r
+ *\r
+ * It's not strictly necessary to call this function. All memory from\r
+ * the notmuch_messages_t object will be reclaimed when the containing\r
+@@ -952,7 +1068,8 @@ notmuch_messages_move_to_next (notmuch_messages_t *messages);\r
+ void\r
+ notmuch_messages_destroy (notmuch_messages_t *messages);\r
+ \r
+-/* Return a list of tags from all messages.\r
++/**\r
++ * Return a list of tags from all messages.\r
+ *\r
+ * The resulting list is guaranteed not to contain duplicated tags.\r
+ *\r
+@@ -967,7 +1084,8 @@ notmuch_messages_destroy (notmuch_messages_t *messages);\r
+ notmuch_tags_t *\r
+ notmuch_messages_collect_tags (notmuch_messages_t *messages);\r
+ \r
+-/* Get the message ID of 'message'.\r
++/**\r
++ * Get the message ID of 'message'.\r
+ *\r
+ * The returned string belongs to 'message' and as such, should not be\r
+ * modified by the caller and will only be valid for as long as the\r
+@@ -981,7 +1099,8 @@ notmuch_messages_collect_tags (notmuch_messages_t *messages);\r
+ const char *\r
+ notmuch_message_get_message_id (notmuch_message_t *message);\r
+ \r
+-/* Get the thread ID of 'message'.\r
++/**\r
++ * Get the thread ID of 'message'.\r
+ *\r
+ * The returned string belongs to 'message' and as such, should not be\r
+ * modified by the caller and will only be valid for as long as the\r
+@@ -995,7 +1114,8 @@ notmuch_message_get_message_id (notmuch_message_t *message);\r
+ const char *\r
+ notmuch_message_get_thread_id (notmuch_message_t *message);\r
+ \r
+-/* Get a notmuch_messages_t iterator for all of the replies to\r
++/**\r
++ * Get a notmuch_messages_t iterator for all of the replies to\r
+ * 'message'.\r
+ *\r
+ * Note: This call only makes sense if 'message' was ultimately\r
+@@ -1015,7 +1135,8 @@ notmuch_message_get_thread_id (notmuch_message_t *message);\r
+ notmuch_messages_t *\r
+ notmuch_message_get_replies (notmuch_message_t *message);\r
+ \r
+-/* Get a filename for the email corresponding to 'message'.\r
++/**\r
++ * Get a filename for the email corresponding to 'message'.\r
+ *\r
+ * The returned filename is an absolute filename, (the initial\r
+ * component will match notmuch_database_get_path() ).\r
+@@ -1033,7 +1154,8 @@ notmuch_message_get_replies (notmuch_message_t *message);\r
+ const char *\r
+ notmuch_message_get_filename (notmuch_message_t *message);\r
+ \r
+-/* Get all filenames for the email corresponding to 'message'.\r
++/**\r
++ * Get all filenames for the email corresponding to 'message'.\r
+ *\r
+ * Returns a notmuch_filenames_t iterator listing all the filenames\r
+ * associated with 'message'. These files may not have identical\r
+@@ -1045,31 +1167,40 @@ notmuch_message_get_filename (notmuch_message_t *message);\r
+ notmuch_filenames_t *\r
+ notmuch_message_get_filenames (notmuch_message_t *message);\r
+ \r
+-/* Message flags */\r
++/**\r
++ * Message flags.\r
++ */\r
+ typedef enum _notmuch_message_flag {\r
+ NOTMUCH_MESSAGE_FLAG_MATCH,\r
+ NOTMUCH_MESSAGE_FLAG_EXCLUDED\r
+ } notmuch_message_flag_t;\r
+ \r
+-/* Get a value of a flag for the email corresponding to 'message'. */\r
++/**\r
++ * Get a value of a flag for the email corresponding to 'message'.\r
++ */\r
+ notmuch_bool_t\r
+ notmuch_message_get_flag (notmuch_message_t *message,\r
+ notmuch_message_flag_t flag);\r
+ \r
+-/* Set a value of a flag for the email corresponding to 'message'. */\r
++/**\r
++ * Set a value of a flag for the email corresponding to 'message'.\r
++ */\r
+ void\r
+ notmuch_message_set_flag (notmuch_message_t *message,\r
+ notmuch_message_flag_t flag, notmuch_bool_t value);\r
+ \r
+-/* Get the date of 'message' as a time_t value.\r
++/**\r
++ * Get the date of 'message' as a time_t value.\r
+ *\r
+ * For the original textual representation of the Date header from the\r
+ * message call notmuch_message_get_header() with a header value of\r
+- * "date". */\r
++ * "date".\r
++ */\r
+ time_t\r
+ notmuch_message_get_date (notmuch_message_t *message);\r
+ \r
+-/* Get the value of the specified header from 'message' as a UTF-8 string.\r
++/**\r
++ * Get the value of the specified header from 'message' as a UTF-8 string.\r
+ *\r
+ * Common headers are stored in the database when the message is\r
+ * indexed and will be returned from the database. Other headers will\r
+@@ -1087,7 +1218,8 @@ notmuch_message_get_date (notmuch_message_t *message);\r
+ const char *\r
+ notmuch_message_get_header (notmuch_message_t *message, const char *header);\r
+ \r
+-/* Get the tags for 'message', returning a notmuch_tags_t object which\r
++/**\r
++ * Get the tags for 'message', returning a notmuch_tags_t object which\r
+ * can be used to iterate over all tags.\r
+ *\r
+ * The tags object is owned by the message and as such, will only be\r
+@@ -1120,10 +1252,13 @@ notmuch_message_get_header (notmuch_message_t *message, const char *header);\r
+ notmuch_tags_t *\r
+ notmuch_message_get_tags (notmuch_message_t *message);\r
+ \r
+-/* The longest possible tag value. */\r
++/**\r
++ * The longest possible tag value.\r
++ */\r
+ #define NOTMUCH_TAG_MAX 200\r
+ \r
+-/* Add a tag to the given message.\r
++/**\r
++ * Add a tag to the given message.\r
+ *\r
+ * Return value:\r
+ *\r
+@@ -1140,7 +1275,8 @@ notmuch_message_get_tags (notmuch_message_t *message);\r
+ notmuch_status_t\r
+ notmuch_message_add_tag (notmuch_message_t *message, const char *tag);\r
+ \r
+-/* Remove a tag from the given message.\r
++/**\r
++ * Remove a tag from the given message.\r
+ *\r
+ * Return value:\r
+ *\r
+@@ -1157,7 +1293,8 @@ notmuch_message_add_tag (notmuch_message_t *message, const char *tag);\r
+ notmuch_status_t\r
+ notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);\r
+ \r
+-/* Remove all tags from the given message.\r
++/**\r
++ * Remove all tags from the given message.\r
+ *\r
+ * See notmuch_message_freeze for an example showing how to safely\r
+ * replace tag values.\r
+@@ -1168,7 +1305,8 @@ notmuch_message_remove_tag (notmuch_message_t *message, const char *tag);\r
+ notmuch_status_t\r
+ notmuch_message_remove_all_tags (notmuch_message_t *message);\r
+ \r
+-/* Add/remove tags according to maildir flags in the message filename(s)\r
++/**\r
++ * Add/remove tags according to maildir flags in the message filename(s).\r
+ *\r
+ * This function examines the filenames of 'message' for maildir\r
+ * flags, and adds or removes tags on 'message' as follows when these\r
+@@ -1202,7 +1340,8 @@ notmuch_message_remove_all_tags (notmuch_message_t *message);\r
+ notmuch_status_t\r
+ notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);\r
+ \r
+-/* Rename message filename(s) to encode tags as maildir flags\r
++/**\r
++ * Rename message filename(s) to encode tags as maildir flags.\r
+ *\r
+ * Specifically, for each filename corresponding to this message:\r
+ *\r
+@@ -1238,7 +1377,8 @@ notmuch_message_maildir_flags_to_tags (notmuch_message_t *message);\r
+ notmuch_status_t\r
+ notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);\r
+ \r
+-/* Freeze the current state of 'message' within the database.\r
++/**\r
++ * Freeze the current state of 'message' within the database.\r
+ *\r
+ * This means that changes to the message state, (via\r
+ * notmuch_message_add_tag, notmuch_message_remove_tag, and\r
+@@ -1281,7 +1421,8 @@ notmuch_message_tags_to_maildir_flags (notmuch_message_t *message);\r
+ notmuch_status_t\r
+ notmuch_message_freeze (notmuch_message_t *message);\r
+ \r
+-/* Thaw the current 'message', synchronizing any changes that may have\r
++/**\r
++ * Thaw the current 'message', synchronizing any changes that may have\r
+ * occurred while 'message' was frozen into the notmuch database.\r
+ *\r
+ * See notmuch_message_freeze for an example of how to use this\r
+@@ -1304,7 +1445,8 @@ notmuch_message_freeze (notmuch_message_t *message);\r
+ notmuch_status_t\r
+ notmuch_message_thaw (notmuch_message_t *message);\r
+ \r
+-/* Destroy a notmuch_message_t object.\r
++/**\r
++ * Destroy a notmuch_message_t object.\r
+ *\r
+ * It can be useful to call this function in the case of a single\r
+ * query object with many messages in the result, (such as iterating\r
+@@ -1315,7 +1457,8 @@ notmuch_message_thaw (notmuch_message_t *message);\r
+ void\r
+ notmuch_message_destroy (notmuch_message_t *message);\r
+ \r
+-/* Is the given 'tags' iterator pointing at a valid tag.\r
++/**\r
++ * Is the given 'tags' iterator pointing at a valid tag.\r
+ *\r
+ * When this function returns TRUE, notmuch_tags_get will return a\r
+ * valid string. Whereas when this function returns FALSE,\r
+@@ -1327,7 +1470,8 @@ notmuch_message_destroy (notmuch_message_t *message);\r
+ notmuch_bool_t\r
+ notmuch_tags_valid (notmuch_tags_t *tags);\r
+ \r
+-/* Get the current tag from 'tags' as a string.\r
++/**\r
++ * Get the current tag from 'tags' as a string.\r
+ *\r
+ * Note: The returned string belongs to 'tags' and has a lifetime\r
+ * identical to it (and the query to which it ultimately belongs).\r
+@@ -1338,7 +1482,8 @@ notmuch_tags_valid (notmuch_tags_t *tags);\r
+ const char *\r
+ notmuch_tags_get (notmuch_tags_t *tags);\r
+ \r
+-/* Move the 'tags' iterator to the next tag.\r
++/**\r
++ * Move the 'tags' iterator to the next tag.\r
+ *\r
+ * If 'tags' is already pointing at the last tag then the iterator\r
+ * will be moved to a point just beyond that last tag, (where\r
+@@ -1351,7 +1496,8 @@ notmuch_tags_get (notmuch_tags_t *tags);\r
+ void\r
+ notmuch_tags_move_to_next (notmuch_tags_t *tags);\r
+ \r
+-/* Destroy a notmuch_tags_t object.\r
++/**\r
++ * Destroy a notmuch_tags_t object.\r
+ *\r
+ * It's not strictly necessary to call this function. All memory from\r
+ * the notmuch_tags_t object will be reclaimed when the containing\r
+@@ -1360,7 +1506,8 @@ notmuch_tags_move_to_next (notmuch_tags_t *tags);\r
+ void\r
+ notmuch_tags_destroy (notmuch_tags_t *tags);\r
+ \r
+-/* Store an mtime within the database for 'directory'.\r
++/**\r
++ * Store an mtime within the database for 'directory'.\r
+ *\r
+ * The 'directory' should be an object retrieved from the database\r
+ * with notmuch_database_get_directory for a particular path.\r
+@@ -1400,35 +1547,44 @@ notmuch_status_t\r
+ notmuch_directory_set_mtime (notmuch_directory_t *directory,\r
+ time_t mtime);\r
+ \r
+-/* Get the mtime of a directory, (as previously stored with\r
++/**\r
++ * Get the mtime of a directory, (as previously stored with\r
+ * notmuch_directory_set_mtime).\r
+ *\r
+ * Returns 0 if no mtime has previously been stored for this\r
+- * directory.*/\r
++ * directory.\r
++ */\r
+ time_t\r
+ notmuch_directory_get_mtime (notmuch_directory_t *directory);\r
+ \r
+-/* Get a notmuch_filenames_t iterator listing all the filenames of\r
++/**\r
++ * Get a notmuch_filenames_t iterator listing all the filenames of\r
+ * messages in the database within the given directory.\r
+ *\r
+ * The returned filenames will be the basename-entries only (not\r
+- * complete paths). */\r
++ * complete paths).\r
++ */\r
+ notmuch_filenames_t *\r
+ notmuch_directory_get_child_files (notmuch_directory_t *directory);\r
+ \r
+-/* Get a notmuch_filenams_t iterator listing all the filenames of\r
++/**\r
++ * Get a notmuch_filenams_t iterator listing all the filenames of\r
+ * sub-directories in the database within the given directory.\r
+ *\r
+ * The returned filenames will be the basename-entries only (not\r
+- * complete paths). */\r
++ * complete paths).\r
++ */\r
+ notmuch_filenames_t *\r
+ notmuch_directory_get_child_directories (notmuch_directory_t *directory);\r
+ \r
+-/* Destroy a notmuch_directory_t object. */\r
++/**\r
++ * Destroy a notmuch_directory_t object.\r
++ */\r
+ void\r
+ notmuch_directory_destroy (notmuch_directory_t *directory);\r
+ \r
+-/* Is the given 'filenames' iterator pointing at a valid filename.\r
++/**\r
++ * Is the given 'filenames' iterator pointing at a valid filename.\r
+ *\r
+ * When this function returns TRUE, notmuch_filenames_get will return\r
+ * a valid string. Whereas when this function returns FALSE,\r
+@@ -1440,7 +1596,8 @@ notmuch_directory_destroy (notmuch_directory_t *directory);\r
+ notmuch_bool_t\r
+ notmuch_filenames_valid (notmuch_filenames_t *filenames);\r
+ \r
+-/* Get the current filename from 'filenames' as a string.\r
++/**\r
++ * Get the current filename from 'filenames' as a string.\r
+ *\r
+ * Note: The returned string belongs to 'filenames' and has a lifetime\r
+ * identical to it (and the directory to which it ultimately belongs).\r
+@@ -1451,7 +1608,8 @@ notmuch_filenames_valid (notmuch_filenames_t *filenames);\r
+ const char *\r
+ notmuch_filenames_get (notmuch_filenames_t *filenames);\r
+ \r
+-/* Move the 'filenames' iterator to the next filename.\r
++/**\r
++ * Move the 'filenames' iterator to the next filename.\r
+ *\r
+ * If 'filenames' is already pointing at the last filename then the\r
+ * iterator will be moved to a point just beyond that last filename,\r
+@@ -1464,7 +1622,8 @@ notmuch_filenames_get (notmuch_filenames_t *filenames);\r
+ void\r
+ notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);\r
+ \r
+-/* Destroy a notmuch_filenames_t object.\r
++/**\r
++ * Destroy a notmuch_filenames_t object.\r
+ *\r
+ * It's not strictly necessary to call this function. All memory from\r
+ * the notmuch_filenames_t object will be reclaimed when the\r
+@@ -1476,6 +1635,8 @@ notmuch_filenames_move_to_next (notmuch_filenames_t *filenames);\r
+ void\r
+ notmuch_filenames_destroy (notmuch_filenames_t *filenames);\r
+ \r
++/* @} */\r
++\r
+ NOTMUCH_END_DECLS\r
+ \r
+ #endif\r
+-- \r
+1.8.5.2\r
+\r
projects / notmuch-archives.git / commitdiff