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

lib: update documentation of callback functions for database_compact and database_upgrade.

Browse source 
Compact was missing callback documentation entirely, and upgrade did not discuss the
closure parameter.
This commit is contained in:
David Bremner 2013-11-03 14:24:46 +02:00 committed by David Bremner
parent 180dba66e4
commit 20abbe89a3
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
lib/notmuch.h
View file

@ -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 * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
* during the compaction process to ensure no writes are made. * 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_status_t
notmuch_database_compact (const char* path, 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 * provide progress indication to the user. If non-NULL it will be
* called periodically with 'progress' as a floating-point value in * 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 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_status_t
notmuch_database_upgrade (notmuch_database_t *database, notmuch_database_upgrade (notmuch_database_t *database,