idmap_autorid: add a comment explaining idmap_autorid_get_domainrange()

Signed-off-by: Michael Adam <obnox@samba.org>

diff --git a/source3/include/idmap_autorid.h b/source3/include/idmap_autorid.h
index 6f741966d6ad670fd5b7dcb6dee029ab8d57b129..5bcb517164e53f1fe537d2c0e65fa65d7cc40d79 100644 (file)
--- a/source3/include/idmap_autorid.h
+++ b/source3/include/idmap_autorid.h
@@ -51,6 +51,13 @@ struct autorid_range_config {
        uint32_t low_id;
 };
 
+/**
+ * Get the range for a pair consisting of the domain sid
+ * and a domain range. If there is no stored range for
+ * this pair and read_only == false, a new range is
+ * acquired by incrementing that range HWM counter in the
+ * database.
+ */
 NTSTATUS idmap_autorid_get_domainrange(struct db_context *db,
                                       struct autorid_range_config *range,
                                       bool read_only);