diff options
| author |  David Bremner <bremner@debian.org> | 2013-11-03 14:24:46 +0200 |
|---|---|---|
| committer |  David Bremner <david@tethera.net> | 2013-11-07 06:50:50 -0400 |
| commit | 20abbe89a3014ff27978aea7be0cffbc715935ca (patch) | |
| tree | bd7d589c41f3cc90053d268fcaa854aa169915c3 /lib | |
| parent | 180dba66e47a5257b2cdf2f1ceb59cc8fa5a69d4 (diff) | |
lib: update documentation of callback functions for database_compact and database_upgrade.
Compact was missing callback documentation entirely, and upgrade did not discuss the
closure parameter.
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/notmuch.h | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/lib/notmuch.h b/lib/notmuch.h index cd301a4f..82fd5998 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -227,6 +227,9 @@ typedef void (*notmuch_compact_status_cb_t)(const char *message, void *closure); * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE * during the compaction process to ensure no writes are made. * + * If the optional callback function 'status_cb' is non-NULL, it will + * be called with diagnostic and informational messages. The argument + * 'closure' is passed verbatim to any callback invoked. */ notmuch_status_t notmuch_database_compact (const char* path, @@ -270,7 +273,8 @@ notmuch_database_needs_upgrade (notmuch_database_t *database); * provide progress indication to the user. If non-NULL it will be * called periodically with 'progress' as a floating-point value in * the range of [0.0 .. 1.0] indicating the progress made so far in - * the upgrade process. + * the upgrade process. The argument 'closure' is passed verbatim to + * any callback invoked. */ notmuch_status_t notmuch_database_upgrade (notmuch_database_t *database, |