[vlc-devel] [PATCH] lib: media_track: improve documentation
Thomas Guillem
thomas at gllm.fr
Fri Jun 12 12:21:58 CEST 2020
Add references to the functions creating tracks and tracklists from the delete
functions.
---
include/vlc/libvlc_media_track.h | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/include/vlc/libvlc_media_track.h b/include/vlc/libvlc_media_track.h
index 4b075a8dee1..e6a4d5d5503 100644
--- a/include/vlc/libvlc_media_track.h
+++ b/include/vlc/libvlc_media_track.h
@@ -194,6 +194,9 @@ libvlc_media_tracklist_at( libvlc_media_tracklist_t *list, size_t index );
*
* \version LibVLC 4.0.0 and later.
*
+ * \see libvlc_media_get_tracklist
+ * \see libvlc_media_player_get_tracklist
+ *
* \param list valid tracklist
*/
LIBVLC_API void
@@ -203,10 +206,14 @@ libvlc_media_tracklist_delete( libvlc_media_tracklist_t *list );
* Release a single track
*
* \version LibVLC 4.0.0 and later.
+ *
* \warning Don't release tracks from a tracklist with this function. Tracks
* from a tracklist are released alongside the list with
* libvlc_media_tracklist_delete()
*
+ * \see libvlc_media_player_get_selected_track
+ * \see libvlc_media_player_get_track_from_id
+ *
* \param track valid track
*/
LIBVLC_API void
--
2.20.1
More information about the vlc-devel
mailing list