ldb: Add Doxygen docs for ldb_schema_attribute_set_override_handler
authorAndrew Bartlett <abartlet@samba.org>
Tue, 30 May 2017 09:00:34 +0000 (21:00 +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 048f6675b1aa11e64c9038a67c1420f7dc1740a2..d8e650e8f2474bf0a2c8edb68297acc6b90554da 100644 (file)
@@ -122,6 +122,14 @@ void ldb_schema_attribute_remove(struct ldb_context *ldb, const char *name);
 /* we allow external code to override the name -> schema_attribute function */
 typedef const struct ldb_schema_attribute *(*ldb_attribute_handler_override_fn_t)(struct ldb_context *, void *, const char *);
 
+/**
+  Allow the caller to define a callback for the attribute handler
+
+  \param ldb The ldb context
+  \param override The callback to be used for attribute lookups
+  \param private_data Private data for the callback
+
+*/
 void ldb_schema_attribute_set_override_handler(struct ldb_context *ldb,
                                               ldb_attribute_handler_override_fn_t override,
                                               void *private_data);