debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-21 18:38:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Re-order documentation a bit.

Browse source 
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.
This commit is contained in:
Carl Worth 2009-10-23 15:17:16 -07:00
parent 03c40c2bb0
commit fd11c8e150
1 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
notmuch.h
View file

@ -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