From: Matthieu Patou <mat@matws.net>
Date: Mon, 17 Dec 2012 09:45:30 +0000 (-0800)
Subject: ldb-tdb: Document ltdb_index_add1 for more clarity
X-Git-Tag: tevent-0.9.18~271
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=75f422fe1df7dd04aa46d5c77cbeb43d101c3ad6;p=thirdparty%2Fsamba.git

ldb-tdb: Document ltdb_index_add1 for more clarity

Reviewed-by: Andrew Bartlett <abartlet@samba.org>
---

diff --git a/lib/ldb/ldb_tdb/ldb_index.c b/lib/ldb/ldb_tdb/ldb_index.c
index d79417f442f..cf210924261 100644
--- a/lib/ldb/ldb_tdb/ldb_index.c
+++ b/lib/ldb/ldb_tdb/ldb_index.c
@@ -1087,9 +1087,26 @@ int ltdb_search_indexed(struct ltdb_context *ac, uint32_t *match_count)
 	return ret;
 }
 
-/*
-  add an index entry for one message element
-*/
+/**
+ * @brief Add a DN in the index list of a given attribute name/value pair
+ *
+ * This function will add the DN in the index list for the index for
+ * the given attribute name and value.
+ *
+ * @param[in]  module       A ldb_module structure
+ *
+ * @param[in]  dn           The string representation of the DN as it
+ *                          will be stored in the index entry
+ *
+ * @param[in]  el           A ldb_message_element array, one of the entry
+ *                          referred by the v_idx is the attribute name and
+ *                          value pair which will be used to construct the
+ *                          index name
+ *
+ * @param[in]  v_idx        The index of element in the el array to use
+ *
+ * @return                  An ldb error code
+ */
 static int ltdb_index_add1(struct ldb_module *module, const char *dn,
 			   struct ldb_message_element *el, int v_idx)
 {