[vlc-commits] libVLC: precise the documentation for chapters_descr parameters

[Jean-Baptiste Kempf]

vlc | branch: master | Jean-Baptiste Kempf <jb at videolan.org> | Fri Jul 10 20:12:38 2015 +0200| [42e04c778c7db2f490878d16f18b2700a87d6df7] | committer: Jean-Baptiste Kempf

libVLC: precise the documentation for chapters_descr parameters

If libvlc_media_player_get_full_chapter_descriptions is called with a
title set to -1, it uses the current title.

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

 include/vlc/libvlc_media_player.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/vlc/libvlc_media_player.h b/include/vlc/libvlc_media_player.h
index 3bccb5b..0a5c8a8 100644
--- a/include/vlc/libvlc_media_player.h
+++ b/include/vlc/libvlc_media_player.h
@@ -1192,7 +1192,7 @@ LIBVLC_API
  * \version LibVLC 3.0.0 and later.
  *
  * \param p_mi the media player
- * \param index of the title to query for chapters
+ * \param index of the title to query for chapters (uses current title if set to -1)
  * \param address to store an allocated array of chapter descriptions
  *        descriptions (must be freed with libvlc_chapter_descriptions_release()
  *        by the caller) [OUT]