From: Emil Velikov <emil.l.velikov@gmail.com>
Date: Mon, 2 Sep 2024 22:20:19 +0000 (+0100)
Subject: libkmod/docs: move in-argument kmod_module*get* reffs
X-Git-Tag: v34~424
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=a65858a33205f88a78fd8881577f1372bd01cd85;p=thirdparty%2Fkmod.git

libkmod/docs: move in-argument kmod_module*get* reffs

Move the references out of the argument's description, to the main
description. With that the "how-to-free" is now duplicate, so remove it.

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/libkmod.h b/libkmod/libkmod.h
index 06423382..4bfe98b0 100644
--- a/libkmod/libkmod.h
+++ b/libkmod/libkmod.h
@@ -977,13 +977,14 @@ const char *kmod_module_get_path(const struct kmod_module *mod);
 /**
  * kmod_module_get_dependency_symbols:
  * @mod: kmod module
- * @list: where to return list of module dependency_symbols. Use
- *        kmod_module_dependency_symbol_get_symbol() and
- *        kmod_module_dependency_symbol_get_crc(). Release this list with
- *        kmod_module_dependency_symbols_free_list()
+ * @list: where to return list of module dependency_symbols
  *
  * Get a list of entries in ELF section ".symtab" or "__ksymtab_strings".
  *
+ * The structure contained in this list is internal to libkmod and its fields
+ * can be obtainsed by calling kmod_module_dependency_symbol_get_crc() and
+ * kmod_module_dependency_symbol_get_symbol().
+ *
  * After use, free the @list by calling
  * kmod_module_dependency_symbols_free_list().
  *
@@ -1099,13 +1100,14 @@ void kmod_module_section_free_list(struct kmod_list *list);
 /**
  * kmod_module_get_symbols:
  * @mod: kmod module
- * @list: where to return list of module symbols. Use
- *        kmod_module_symbol_get_symbol() and
- *        kmod_module_symbol_get_crc(). Release this list with
- *        kmod_module_symbols_free_list()
+ * @list: where to return list of module symbols
  *
  * Get a list of entries in ELF section ".symtab" or "__ksymtab_strings".
  *
+ * The structure contained in this list is internal to libkmod and its fields
+ * can be obtainsed by calling kmod_module_symbol_get_crc() and
+ * kmod_module_symbol_get_symbol().
+ *
  * After use, free the @list by calling kmod_module_symbols_free_list().
  *
  * Returns: 0 on success or < 0 otherwise.
@@ -1149,13 +1151,14 @@ void kmod_module_symbols_free_list(struct kmod_list *list);
 /**
  * kmod_module_get_versions:
  * @mod: kmod module
- * @list: where to return list of module versions. Use
- *        kmod_module_version_get_symbol() and
- *        kmod_module_version_get_crc(). Release this list with
- *        kmod_module_versions_free_list()
+ * @list: where to return list of module versions
  *
  * Get a list of entries in ELF section "__versions".
  *
+ * The structure contained in this list is internal to libkmod and its fields
+ * can be obtainsed by calling kmod_module_version_get_crc() and
+ * kmod_module_version_get_symbol().
+ *
  * After use, free the @list by calling kmod_module_versions_free_list().
  *
  * Returns: 0 on success or < 0 otherwise.
@@ -1195,10 +1198,7 @@ void kmod_module_versions_free_list(struct kmod_list *list);
 /**
  * kmod_module_get_info:
  * @mod: kmod module
- * @list: where to return list of module information. Use
- *        kmod_module_info_get_key() and
- *        kmod_module_info_get_value(). Release this list with
- *        kmod_module_info_free_list()
+ * @list: where to return list of module information
  *
  * Get a list of entries in ELF section ".modinfo", these contain
  * alias, license, depends, vermagic and other keys with respective
@@ -1206,6 +1206,10 @@ void kmod_module_versions_free_list(struct kmod_list *list);
  * about the module signature is included as well: signer,
  * sig_key and sig_hashalgo.
  *
+ * The structure contained in this list is internal to libkmod and its fields
+ * can be obtainsed by calling kmod_module_info_get_key() and
+ * kmod_module_info_get_value().
+ *
  * After use, free the @list by calling kmod_module_info_free_list().
  *
  * Returns: number of entries in @list on success or < 0 otherwise.