[vlc-commits] [Git][videolan/vlc][master] modules: move docs of public functions to header

[Jean-Baptiste Kempf (@jbk)]

Jean-Baptiste Kempf pushed to branch master at VideoLAN / VLC


Commits:
c6c30498 by Lyndon Brown at 2021-07-01T10:10:39+00:00
modules: move docs of public functions to header

also:
 - fix obsolete/incorrect mention of `length` param of `module_list_free()`.
 - fix a typo.

- - - - -


2 changed files:

- include/vlc_modules.h
- src/modules/bank.c


Changes:

=====================================
include/vlc_modules.h
=====================================
@@ -157,13 +157,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;
 
 /**


=====================================
src/modules/bank.c
=====================================
@@ -811,23 +811,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;



View it on GitLab: https://code.videolan.org/videolan/vlc/-/commit/c6c304983f33c628779b4bad6a099095b4108c31

-- 
View it on GitLab: https://code.videolan.org/videolan/vlc/-/commit/c6c304983f33c628779b4bad6a099095b4108c31
You're receiving this email because of your account on code.videolan.org.