r13855: Docs for the registry library as well

(This used to be commit ad43464cc1d1fdb59a26e612e0b4ec85ef4a43d2)

1 files changed, 8 insertions, 2 deletions

diff --git a/source4/lib/registry/common/reg_util.c b/source4/lib/registry/common/reg_util.c
index 75f9d3cf00..a35e55696b 100644
--- a/source4/lib/registry/common/reg_util.c
+++ b/source4/lib/registry/common/reg_util.c
@@ -22,6 +22,11 @@
 #include "lib/registry/registry.h"
 #include "librpc/gen_ndr/winreg.h"
 
+/**
+ * @file
+ * @brief Registry utility functions
+ */
+
 static const struct {
 	uint32_t id;
 	const char *name;
@@ -34,7 +39,7 @@ static const struct {
 	{ 0, NULL }
 };
 
-/* Return string description of registry value type */
+/** Return string description of registry value type */
 const char *str_regtype(int type)
 {
 	int i;
@@ -79,6 +84,7 @@ char *reg_val_data_string(TALLOC_CTX *mem_ctx, uint32_t type, DATA_BLOB *data)
   return ret;
 }
 
+/** Generate a string that describes a registry value */
 char *reg_val_description(TALLOC_CTX *mem_ctx, struct registry_value *val) 
 {
 	return talloc_asprintf(mem_ctx, "%s = %s : %s", val->name?val->name:"<No Name>", str_regtype(val->data_type), reg_val_data_string(mem_ctx, val->data_type, &val->data));
@@ -154,7 +160,7 @@ char *reg_path_unix2win(char *path)
 	return path;
 }
 
-/* Open a key by name (including the predefined key name!) */
+/** Open a key by name (including the predefined key name!) */
 WERROR reg_open_key_abs(TALLOC_CTX *mem_ctx, struct registry_context *handle, const char *name, struct registry_key **result)
 {
 	struct registry_key *predef;