]> git.ipfire.org Git - thirdparty/kmod.git/commitdiff
libkmod/docs: add outstanding long_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 6612206524e5dc919bc3389312bdbbffd51ac0f8..8d6be1d436d3bfa07fcfa7bad4560a4290dac586 100644 (file)
@@ -254,13 +254,10 @@ const char *kmod_get_dirname(const struct kmod_ctx *ctx);
 /**
  * SECTION:libkmod-list
  * @short_description: general purpose list
- */
-
-/*
- * kmod_list
  *
- * access to kmod generated lists
+ * Access to kmod generated lists.
  */
+
 struct kmod_list;
 
 #define kmod_list_foreach(list_entry, first_entry) \
@@ -325,14 +322,11 @@ struct kmod_list *kmod_list_prev(const struct kmod_list *list,
 /**
  * SECTION:libkmod-config
  * @short_description: retrieve current libkmod configuration
- */
-
-/*
- * kmod_config_iter
  *
- * access to configuration lists - it allows to get each configuration's
- * key/value stored by kmod
+ * Access to configuration lists - it allows to get each configuration's
+ * key/value stored by kmod.
  */
+
 struct kmod_config_iter;
 
 /**
@@ -483,6 +477,9 @@ void kmod_config_iter_free_iter(struct kmod_config_iter *iter);
 /**
  * SECTION:libkmod-module
  * @short_description: operate on kernel modules
+ *
+ * Wide range of function to operate on kernel modules - loading, unloading,
+ * reference counting, retrieving a list of module dependencies and more.
  */
 
 /*