From: Carl Worth <cworth@cworth.org>
Date: Fri, 23 Oct 2009 22:17:16 +0000 (-0700)
Subject: Re-order documentation a bit.
X-Git-Tag: 0.1~746
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=fd11c8e150c1b41ca1efc0ba4a3465eb325457f2;p=notmuch.git

Re-order documentation a bit.

The notmuch_database_get_default_path function is unique in not
accepting a notmuch_database_t* (nor creating one). So list it
outside the other notmuch_database functions.
---

diff --git a/notmuch.h b/notmuch.h
index 103d2331..e93caaa6 100644
--- a/notmuch.h
+++ b/notmuch.h
@@ -104,6 +104,19 @@ typedef struct _notmuch_message notmuch_message_t;
 typedef struct _notmuch_tags notmuch_tags_t;
 typedef struct _notmuch_thread_ids notmuch_thread_ids_t;
 
+/* Lookup the default database path.
+ *
+ * This is the path that will be used by notmuch_database_create and
+ * notmuch_database_open if given a NULL path. Specifically it will be
+ * the value of the NOTMUCH_BASE environment variable if set,
+ * otherwise ${HOME}/mail
+ *
+ * Returns a newly allocated string which the caller should free()
+ * when finished with it.
+ */
+char *
+notmuch_database_default_path (void);
+
 /* Create a new, empty notmuch database located at 'path'.
  *
  * The path should be a top-level directory to a collection of
@@ -159,19 +172,6 @@ notmuch_database_open (const char *path);
 void
 notmuch_database_close (notmuch_database_t *database);
 
-/* Lookup the default database path.
- *
- * This is the path that will be used by notmuch_database_create and
- * notmuch_database_open if given a NULL path. Specifically it will be
- * the value of the NOTMUCH_BASE environment variable if set,
- * otherwise ${HOME}/mail
- *
- * Returns a newly allocated string which the caller should free()
- * when finished with it.
- */
-char *
-notmuch_database_default_path (void);
-
 /* Return the database path of the given database.
  *
  * The return value is a string owned by notmuch so should not be