[vlc-devel] [PATCH 10/19] modules: move documentation to vlc_modules.h

[Kartik Ohri]

From: rustyc <amcap1712 at gmail.com>

Move documentation for VLC API methods module_list_free and
module_list_get from src/modules/bank.c to include/vlc_modules.h.
---
 include/vlc_modules.h | 13 +++++++++++++
 src/modules/bank.c    | 12 ------------
 2 files changed, 13 insertions(+), 12 deletions(-)

diff --git a/include/vlc_modules.h b/include/vlc_modules.h
index 430863953c..acaf73eb8b 100644
--- a/include/vlc_modules.h
+++ b/include/vlc_modules.h
@@ -124,7 +124,20 @@ VLC_API module_config_t *module_config_get(const module_t *module,
  */
 VLC_API void module_config_free( module_config_t *tab);
 
+/**
+ * Frees the flat list of VLC modules.
+ * @param list list obtained by module_list_get()
+ * @param length number of items on the list
+ * @return nothing.
+ */
 VLC_API void module_list_free(module_t **);
+
+/**
+ * Gets the flat list of VLC modules.
+ * @param n [OUT] pointer to the number of modules
+ * @return table of module pointers (release with module_list_free()),
+ *         or NULL in case of error (in that case, *n is zeroed).
+ */
 VLC_API module_t ** module_list_get(size_t *n) VLC_USED;
 
 /**
diff --git a/src/modules/bank.c b/src/modules/bank.c
index d3f89b60e8..3bc8972069 100644
--- a/src/modules/bank.c
+++ b/src/modules/bank.c
@@ -745,23 +745,11 @@ void module_LoadPlugins(vlc_object_t *obj)
     msg_Dbg (obj, "plug-ins loaded: %zu modules", count);
 }
 
-/**
- * Frees the flat list of VLC modules.
- * @param list list obtained by module_list_get()
- * @param length number of items on the list
- * @return nothing.
- */
 void module_list_free (module_t **list)
 {
     free (list);
 }
 
-/**
- * Gets the flat list of VLC modules.
- * @param n [OUT] pointer to the number of modules
- * @return table of module pointers (release with module_list_free()),
- *         or NULL in case of error (in that case, *n is zeroed).
- */
 module_t **module_list_get (size_t *n)
 {
     module_t **tab = NULL;
-- 
2.25.1