]> git.ipfire.org Git - thirdparty/kmod.git/commitdiff
libkmod/docs: add outstanding struct description(s)
authorEmil Velikov <emil.l.velikov@gmail.com>
Mon, 2 Sep 2024 22:20:19 +0000 (23:20 +0100)
committerLucas De Marchi <lucas.de.marchi@gmail.com>
Fri, 6 Sep 2024 16:43:24 +0000 (11:43 -0500)
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>
libkmod/libkmod.h

index 0553f9f49acead98332749b0ee54506dda46f7c9..2883d155320fbe650558441f677ba5e479c79abe 100644 (file)
@@ -260,6 +260,11 @@ const char *kmod_get_dirname(const struct kmod_ctx *ctx);
  * Access to kmod generated lists.
  */
 
+/**
+ * kmod_list:
+ *
+ * Opaque object for a circular (doubly linked) list.
+ */
 struct kmod_list;
 
 #define kmod_list_foreach(list_entry, first_entry) \
@@ -329,6 +334,11 @@ struct kmod_list *kmod_list_prev(const struct kmod_list *list,
  * key/value stored by kmod.
  */
 
+/**
+ * kmod_config_iter:
+ *
+ * Opaque object for iterating and retrieving configuration information.
+ */
 struct kmod_config_iter;
 
 /**