Add doc to kmod_dump_index

[thirdparty/kmod.git] / libkmod / libkmod.c

diff --git a/libkmod/libkmod.c b/libkmod/libkmod.c
index f544c66d73bc65184aee21980240083556969d6f..800a1784ffeb916f49ea8ab0e52f1de377c3512f 100644 (file)
--- a/libkmod/libkmod.c
+++ b/libkmod/libkmod.c
@@ -746,6 +746,16 @@ KMOD_EXPORT void kmod_unload_resources(struct kmod_ctx *ctx)
        }
 }
 
+/**
+ * kmod_dump_index:
+ * @ctx: kmod library context
+ * @type: index to dump
+ * @fd: file descriptor to dump index to
+ *
+ * Dump index to file descriptor
+ *
+ * Returns: 0 on success or < 0 otherwise.
+ */
 KMOD_EXPORT int kmod_dump_index(struct kmod_ctx *ctx, enum kmod_index type,
                                                                        int fd)
 {