videolan
/
vlc
mirror of https://code.videolan.org/videolan/vlc
1
Fork 0
Code Releases Activity

vlc_renderer_discovery: fix doxygen warnings 

include/vlc_renderer_discovery.h:121: warning: The following parameter of vlc_rd_get_names(vlc_object_t *p_obj, char ***pppsz_names, char ***pppsz_longnames) is not documented:
      parameter 'p_obj'

    include/vlc_renderer_discovery.h:136: warning: The following parameters of vlc_rd_new(vlc_object_t *p_obj, const char *psz_name, const struct vlc_renderer_discovery_owner *owner) are not documented:
      parameter 'p_obj'
      parameter 'owner'
This commit is contained in:
Alexandre Janniaux 2023-07-06 09:52:14 +02:00 committed by Steve Lhomme
parent a0e6fc35d1
commit 740f65fbe4
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
include/vlc_renderer_discovery.h
View File

@ -119,6 +119,7 @@ struct vlc_renderer_discovery_owner;
/**
* Return a list of renderer discovery modules
*
* @param p_obj any VLC object to get a libvlc instance from TODO
* @param pppsz_names a pointer to a list of module name, NULL terminated
* @param pppsz_longnames a pointer to a list of module longname, NULL
* terminated
@ -134,8 +135,11 @@ vlc_rd_get_names(vlc_object_t *p_obj, char ***pppsz_names,
/**
* Create a new renderer discovery module
*
* @param p_obj the parent VLC object the variables will be inherited from
* @param psz_name name of the module to load, see vlc_rd_get_names() to get
* the list of names
* @param owner owner object with callback that the renderer discovery will
* notify when new renderers are found or removed
*
* @return a valid vlc_renderer_discovery, need to be released with
* vlc_rd_release()