idmap_autorid: add a comment explaining idmap_autorid_init_hwm()

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

diff --git a/source3/include/idmap_autorid.h b/source3/include/idmap_autorid.h
index 5bcb517164e53f1fe537d2c0e65fa65d7cc40d79..bf96d765d1579b5c508cba5c1ef353f1d3fd800e 100644 (file)
--- a/source3/include/idmap_autorid.h
+++ b/source3/include/idmap_autorid.h
@@ -81,6 +81,10 @@ NTSTATUS idmap_autorid_setrange(struct db_context *db,
                                uint32_t domain_range_index,
                                uint32_t rangenum);
 
+/**
+ * Initialize a specified HWM value to 0 if it is not
+ * yet present in the database.
+ */
 NTSTATUS idmap_autorid_init_hwm(struct db_context *db, const char *hwm);
 
 NTSTATUS idmap_autorid_db_init(const char *path,