diff options
author | Carl Worth <cworth@cworth.org> | 2009-10-23 15:17:16 -0700 |
---|---|---|
committer | Carl Worth <cworth@cworth.org> | 2009-10-23 15:17:16 -0700 |
commit | fd11c8e150c1b41ca1efc0ba4a3465eb325457f2 (patch) | |
tree | 2d71f3e90e1535e9cf28c2b3d43088ee82c3bbfe /notmuch.h | |
parent | 03c40c2bb04a762539e5fbc9924a1ce1e5548cc8 (diff) |
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.
Diffstat (limited to 'notmuch.h')
-rw-r--r-- | notmuch.h | 26 |
1 files changed, 13 insertions, 13 deletions
@@ -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 |