[vlc-devel] [PATCH] modules: move docs to header

[Lyndon Brown]

attached. preview:


From: Lyndon Brown <jnqnfe at gmail.com>
Date: Mon, 8 Apr 2019 21:55:13 +0100
Subject: modules: move docs to header


diff --git a/include/vlc_modules.h b/include/vlc_modules.h
index 6dbb891240..a12fb7995c 100644
--- a/include/vlc_modules.h
+++ b/include/vlc_modules.h
@@ -154,13 +154,26 @@ VLC_API module_config_t *module_config_get(const module_t *module,
                                            unsigned *restrict psize) VLC_USED;
 
 /**
- * Releases the configuration items table.
+ * Releases a configuration items table.
  *
  * \param tab base address of a table returned by module_config_get()
  */
 VLC_API void module_config_free( module_config_t *tab);
 
+/**
+ * Frees a flat list of VLC modules.
+ *
+ * \param list list obtained by module_list_get()
+ */
 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 12330d695d..19167330fc 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;
-------------- next part --------------
A non-text attachment was scrubbed...
Name: mod_headers.patch
Type: text/x-patch
Size: 2011 bytes
Desc: not available
URL: <http://mailman.videolan.org/pipermail/vlc-devel/attachments/20200926/fe758718/attachment.bin>