libkmod/docs: document and reference kmod_index

Mostly move the existing documentation from kmod_dump_index().

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: https://github.com/kmod-project/kmod/pull/94
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>

diff --git a/libkmod/docs/libkmod-sections.txt b/libkmod/docs/libkmod-sections.txt
index 704409fc1dfb9a97bdc09c7a7dacb301b55c9091..6ae614f46ac6f1f4c3dfc8619f163e672512cd89 100644 (file)
--- a/libkmod/docs/libkmod-sections.txt
+++ b/libkmod/docs/libkmod-sections.txt
@@ -9,6 +9,7 @@ kmod_load_resources
 kmod_unload_resources
 kmod_resources
 kmod_validate_resources
+kmod_index
 kmod_dump_index
 
 kmod_set_log_priority

diff --git a/libkmod/libkmod.h b/libkmod/libkmod.h
index fcfcecbb0d2cc04384664884599a40f0747f5463..39e832384be5c4bdc9e8c7b1ee7f47f24fea8ad6 100644 (file)
--- a/libkmod/libkmod.h
+++ b/libkmod/libkmod.h
@@ -150,25 +150,30 @@ enum kmod_resources {
  */
 int kmod_validate_resources(struct kmod_ctx *ctx);
 
+/**
+ * kmod_index:
+ * @KMOD_INDEX_MODULES_DEP: index of module dependencies
+ * @KMOD_INDEX_MODULES_ALIAS: index of module aliases
+ * @KMOD_INDEX_MODULES_SYMBOL: index of symbol aliases
+ * @KMOD_INDEX_MODULES_BUILTIN_ALIAS: index of builtin module aliases
+ * @KMOD_INDEX_MODULES_BUILTIN: index of builtin module
+ * @_KMOD_INDEX_PAD: DO NOT USE; padding to make sure enum is not mapped to char
+ *
+ * The (module) index type, used by kmod_dump_index().
+ */
 enum kmod_index {
        KMOD_INDEX_MODULES_DEP = 0,
        KMOD_INDEX_MODULES_ALIAS,
        KMOD_INDEX_MODULES_SYMBOL,
        KMOD_INDEX_MODULES_BUILTIN_ALIAS,
        KMOD_INDEX_MODULES_BUILTIN,
-       /* Padding to make sure enum is not mapped to char */
        _KMOD_INDEX_PAD = 1U << 31,
 };
 
 /**
  * kmod_dump_index:
  * @ctx: kmod library context
- * @type: index to dump, valid indexes are
- * KMOD_INDEX_MODULES_DEP: index of module dependencies;
- * KMOD_INDEX_MODULES_ALIAS: index of module aliases;
- * KMOD_INDEX_MODULES_SYMBOL: index of symbol aliases;
- * KMOD_INDEX_MODULES_BUILTIN_ALIAS: index of builtin module aliases.
- * KMOD_INDEX_MODULES_BUILTIN: index of builtin module.
+ * @type: index to dump, valid indexes are #kmod_index
  * @fd: file descriptor to dump index to
  *
  * Dump index to file descriptor. Note that this function doesn't use stdio.h