[vlc-devel] [PATCH 2/2] libvlc: media: update reference to libvlc_media_parse

[Alexandre Janniaux]

libvlc_media_parse is now deprecated and the correct function should be
mentioned in the documentation instead. Update the references and
replace them with libvlc_media_parse_with_options.
---
 include/vlc/libvlc_media.h | 22 +++++++++++++---------
 1 file changed, 13 insertions(+), 9 deletions(-)

diff --git a/include/vlc/libvlc_media.h b/include/vlc/libvlc_media.h
index c7b68ea4cd..9f806a2e40 100644
--- a/include/vlc/libvlc_media.h
+++ b/include/vlc/libvlc_media.h
@@ -556,11 +556,10 @@ LIBVLC_API libvlc_media_t *libvlc_media_duplicate( libvlc_media_t *p_md );
 /**
  * Read the meta of the media.
  *
- * Note, you need to call libvlc_media_parse() or play the media at least once
- * before calling this function.
+ * Note, you need to call libvlc_media_parse_with_options() or play the media
+ * at least once before calling this function.
  * If the media has not yet been parsed this will return NULL.
  *
- * \see libvlc_media_parse
  * \see libvlc_media_parse_with_options
  * \see libvlc_MediaMetaChanged
  *
@@ -645,10 +644,12 @@ LIBVLC_API libvlc_event_manager_t *
 /**
  * Get duration (in ms) of media descriptor object item.
  *
- * Note, you need to call libvlc_media_parse() or play the media at least once
- * before calling this function.
+ * Note, you need to call libvlc_media_parse_with_options() or play the media
+ * at least once before calling this function.
  * Not doing this will result in an undefined result.
  *
+ * \see libvlc_media_parse_with_options
+ *
  * \param p_md media descriptor object
  * \return duration of media item or -1 on error
  */
@@ -708,6 +709,7 @@ libvlc_media_parse_stop( libvlc_media_t *p_md );
  *
  * \see libvlc_MediaParsedChanged
  * \see libvlc_media_parsed_status_t
+ * \see libvlc_media_parse_with_options
  *
  * \param p_md media descriptor object
  * \return a value of the libvlc_media_parsed_status_t enum
@@ -741,11 +743,12 @@ LIBVLC_API void *libvlc_media_get_user_data( libvlc_media_t *p_md );
 /**
  * Get media descriptor's elementary streams description
  *
- * Note, you need to call libvlc_media_parse() or play the media at least once
- * before calling this function.
+ * Note, you need to call libvlc_media_parse_with_options() or play the media
+ * at least once before calling this function.
  * Not doing this will result in an empty array.
  *
  * \version LibVLC 2.1.0 and later.
+ * \see libvlc_media_parse_with_options
  *
  * \param p_md media descriptor object
  * \param tracks address to store an allocated array of Elementary Streams
@@ -761,12 +764,13 @@ unsigned libvlc_media_tracks_get( libvlc_media_t *p_md,
 /**
  * Get codec description from media elementary stream
  *
- * Note, you need to call libvlc_media_parse() or play the media at least once
- * before calling this function.
+ * Note, you need to call libvlc_media_parse_with_options() or play the media
+ * at least once before calling this function.
  *
  * \version LibVLC 3.0.0 and later.
  *
  * \see libvlc_media_track_t
+ * \see libvlc_media_parse_with_options
  *
  * \param i_type i_type from libvlc_media_track_t
  * \param i_codec i_codec or i_original_fourcc from libvlc_media_track_t
-- 
2.24.0