ldb: Add Doxygen docs for ldb_schema_set_override_indexlist()
authorAndrew Bartlett <abartlet@samba.org>
Tue, 30 May 2017 09:04:02 +0000 (21:04 +1200)
committerAndrew Bartlett <abartlet@samba.org>
Wed, 31 May 2017 04:34:27 +0000 (06:34 +0200)
Signed-off-by: Andrew Bartlett <abartlet@samba.org>
Reviewed-by: Douglas Bagnall <douglas.bagnall@catalyst.net.nz>
lib/ldb/include/ldb_module.h

index d8e650e8f2474bf0a2c8edb68297acc6b90554da..dab3d2e82359ed0c33ddacb7cfb513e86838b57f 100644 (file)
@@ -133,6 +133,16 @@ typedef const struct ldb_schema_attribute *(*ldb_attribute_handler_override_fn_t
 void ldb_schema_attribute_set_override_handler(struct ldb_context *ldb,
                                               ldb_attribute_handler_override_fn_t override,
                                               void *private_data);
+
+/**
+  Allow the caller to define that the callback for the attribute handler
+  also overrides the index list
+
+  \param ldb The ldb context
+  \param one_level_indexes Indicates that the index for SCOPE_ONELEVEL
+         should also be maintained
+
+*/
 void ldb_schema_set_override_indexlist(struct ldb_context *ldb,
                                       bool one_level_indexes);