diff options
author | Andrew Bartlett <abartlet@samba.org> | 2017-05-04 11:39:21 +0200 |
---|---|---|
committer | Andrew Bartlett <abartlet@samba.org> | 2017-05-31 06:34:27 +0200 |
commit | ba3eff930f9edd51f6e6cfd7f6f927e4aae6da1b (patch) | |
tree | 959cf91c449630365501aa7ee15eda2bcd75d06d /lib | |
parent | d73d926458fd92f15287fa6bc0246b79d06c94d4 (diff) | |
download | samba-ba3eff930f9edd51f6e6cfd7f6f927e4aae6da1b.tar.gz |
ldb: Add Doxygen docs for ldb_handle_get_event_context()
Signed-off-by: Andrew Bartlett <abartlet@samba.org>
Reviewed-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
Diffstat (limited to 'lib')
-rw-r--r-- | lib/ldb/include/ldb_module.h | 13 |
1 files changed, 9 insertions, 4 deletions
diff --git a/lib/ldb/include/ldb_module.h b/lib/ldb/include/ldb_module.h index dab3d2e8235..9fbbe0dcf78 100644 --- a/lib/ldb/include/ldb_module.h +++ b/lib/ldb/include/ldb_module.h @@ -230,10 +230,15 @@ int ldb_register_backend(const char *url_prefix, ldb_connect_fn, bool); struct ldb_handle *ldb_handle_new(TALLOC_CTX *mem_ctx, struct ldb_context *ldb); -/* - * This function obtains the private event context for the handle, - * which may have been created to avoid nested event loops during - * ldb_tdb with the locks held +/** + Obtains the private event context for the handle, + + A private event context may have been created to avoid nested event + loops during ldb_tdb with the locks held. Otherwise return the + global one. + + \param handle The ldb handle to obtain the event context for + \return the tevent event context for this handle (private or global) */ struct tevent_context *ldb_handle_get_event_context(struct ldb_handle *handle); |