diff options
| author | David Bremner <david@tethera.net> | 2023-05-29 08:01:40 -0300 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2023-07-09 12:08:28 -0300 |
| commit | a62b8a95c0e890f11cb39cc2aaea3a4893c8268d (patch) | |
| tree | ad565f2575d2f8ba05eb812f2d9f0303898d85da /lib | |
| parent | 808fd6f258e6f74f4cdb5b6f61fe102bdba59e6e (diff) | |
doc/lib: clarify ownership for notmuch_database_get_revision
The ownership is implicit in the const declaration (I think!), but
that does not show up in the doxygen generated API docs.
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/notmuch.h | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/lib/notmuch.h b/lib/notmuch.h index 76156178..4e2b0fa4 100644 --- a/lib/notmuch.h +++ b/lib/notmuch.h @@ -722,7 +722,8 @@ notmuch_database_end_atomic (notmuch_database_t *notmuch); * * The UUID is a NUL-terminated opaque string that uniquely identifies * this database. Two revision numbers are only comparable if they - * have the same database UUID. + * have the same database UUID. The string 'uuid' is owned by notmuch + * and should not be freed or modified by the user. */ unsigned long notmuch_database_get_revision (notmuch_database_t *notmuch, |