[vlc-commits] player: improve documentation

[Thomas Guillem]

vlc | branch: master | Thomas Guillem <thomas at gllm.fr> | Wed Jun 19 13:31:51 2019 +0200| [f519b12e1d0df1080d7f5ecffa512b012ccef10d] | committer: Thomas Guillem

player: improve documentation

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=f519b12e1d0df1080d7f5ecffa512b012ccef10d
---

 include/vlc_player.h | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/include/vlc_player.h b/include/vlc_player.h
index 9eec9a70b8..54b8a85eb9 100644
--- a/include/vlc_player.h
+++ b/include/vlc_player.h
@@ -100,6 +100,12 @@ struct vlc_player_program
 
 /**
  * Player track structure.
+ *
+ * A track is a representation of an ES identifier at a given time. Once the
+ * player is unlocked, all content except the es_id pointer can be updated.
+ *
+ * @see vlc_player_cbs.on_track_list_changed
+ * @see vlc_player_GetTrack
  */
 struct vlc_player_track
 {
@@ -938,6 +944,9 @@ struct vlc_player_aout_cbs
  * This function can be used to pass a track from a callback to an other
  * context. The es_id will be held by the duplicated track.
  *
+ * @warning The returned track won't be updated if the original one is modified
+ * by the player.
+ *
  * @see vlc_player_cbs.on_track_list_changed
  *
  * @return a duplicated track or NULL on allocation error