From: Andrew Bartlett Date: Thu, 4 May 2017 09:39:21 +0000 (+0200) Subject: ldb: Add Doxygen docs for ldb_handle_get_event_context() X-Git-Tag: ldb-1.1.30~3 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ba3eff930f9edd51f6e6cfd7f6f927e4aae6da1b;p=thirdparty%2Fsamba.git ldb: Add Doxygen docs for ldb_handle_get_event_context() Signed-off-by: Andrew Bartlett Reviewed-by: Douglas Bagnall --- 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);