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

vlc_playlist: fix doxygen warnings 

include/vlc_playlist.h:873: warning: The following parameter of vlc_playlist_Export(vlc_playlist_t *playlist, const char *filename, const char *type) is not documented:
      parameter 'playlist'

    include/vlc_playlist.h:439: warning: Found unknown command '\index'

    include/vlc_playlist.h:436: warning: The following parameter of vlc_playlist_Insert(vlc_playlist_t *playlist, size_t index, input_item_t *const media[], size_t count) is not documented:
      parameter 'index'

    include/vlc_playlist.h:454: warning: Found unknown command '\index'

    include/vlc_playlist.h:451: warning: The following parameter of vlc_playlist_InsertOne(vlc_playlist_t *playlist, size_t index, input_item_t *media) is not documented:
      parameter 'index'

    include/vlc_playlist.h:565: warning: Found unknown command '\index'

    include/vlc_playlist.h:555: warning: The following parameter of vlc_playlist_RequestInsert(vlc_playlist_t *playlist, size_t index, input_item_t *const media[], size_t count) is not documented:
      parameter 'index'
This commit is contained in:
Alexandre Janniaux 2023-07-06 10:32:47 +02:00 committed by Steve Lhomme
parent 16dfe02d58
commit ed1cf916b7
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
include/vlc_playlist.h
View File

@ -435,7 +435,7 @@ vlc_playlist_Clear(vlc_playlist_t *playlist);
* The index must be in range (less than or equal to vlc_playlist_Count()).
*
* \param playlist the playlist, locked
* \index index the index where the media are to be inserted
* \param index the index where the media are to be inserted
* \param media the array of media to insert
* \param count the number of media to insert
* \return VLC_SUCCESS on success, another value on error
@ -450,7 +450,7 @@ vlc_playlist_Insert(vlc_playlist_t *playlist, size_t index,
* The index must be in range (less than or equal to vlc_playlist_Count()).
*
* \param playlist the playlist, locked
* \index index the index where the media is to be inserted
* \param index the index where the media is to be inserted
* \param media the media to insert
* \return VLC_SUCCESS on success, another value on error
*/
@ -561,7 +561,7 @@ vlc_playlist_RemoveOne(vlc_playlist_t *playlist, size_t index)
* change.
*
* \param playlist the playlist, locked
* \index index the index where the media are to be inserted
* \param index the index where the media are to be inserted
* \param media the array of media to insert
* \param count the number of media to insert
* \return VLC_SUCCESS on success, another value on error
@ -869,6 +869,7 @@ vlc_playlist_Preparse(vlc_playlist_t *playlist, input_item_t *media);
/**
* Export the playlist to a file.
*
* \param playlist a playlist instance
* \param filename the location where the exported file will be saved
* \param type the type of the playlist file to create (m3u, m3u8, xspf, ...)
* \return VLC_SUCCESS on success, another value on error