[vlc-commits] [Git][videolan/vlc][master] lib: fix incorrect documentation in public headers

[Steve Lhomme (@robUx4)]

Steve Lhomme pushed to branch master at VideoLAN / VLC


Commits:
be168d90 by Ayush Dey at 2026-07-02T08:04:46+00:00
lib: fix incorrect documentation in public headers

No functional changes.

- - - - -


5 changed files:

- include/vlc/libvlc_media_discoverer.h
- include/vlc/libvlc_media_list_player.h
- include/vlc/libvlc_media_player.h
- include/vlc/libvlc_parser.h
- include/vlc/libvlc_renderer_discoverer.h


Changes:

=====================================
include/vlc/libvlc_media_discoverer.h
=====================================
@@ -133,7 +133,7 @@ libvlc_media_discoverer_new( libvlc_instance_t * p_inst,
  * Start media discovery.
  *
  * To stop it, call libvlc_media_discoverer_stop() or
- * libvlc_media_discoverer_list_release() directly.
+ * libvlc_media_discoverer_destroy() directly.
  *
  * \see libvlc_media_discoverer_stop
  *
@@ -156,8 +156,8 @@ LIBVLC_API void
 libvlc_media_discoverer_stop( libvlc_media_discoverer_t * p_mdis );
 
 /**
- * Release media discover object. If the reference count reaches 0, then
- * the object will be released.
+ * Destroy a media discoverer object. If the discovery is running, it will be
+ * stopped first.
  *
  * \param p_mdis media service discover object
  * \version LibVLC 4.0.0 or later


=====================================
include/vlc/libvlc_media_list_player.h
=====================================
@@ -77,9 +77,9 @@ LIBVLC_API libvlc_media_list_player_t *
 
 /**
  * Release a media_list_player after use
- * Decrement the reference count of a media player object. If the
+ * Decrement the reference count of a media list player object. If the
  * reference count is 0, then libvlc_media_list_player_release() will
- * release the media player object. If the media player object
+ * release the media list player object. If the media list player object
  * has been released, then it should not be used again.
  *
  * \param p_mlp media list player instance


=====================================
include/vlc/libvlc_media_player.h
=====================================
@@ -506,7 +506,7 @@ struct libvlc_media_player_cbs
 
 
     /**
-     * Callback protootype that notify when the player added new attachments to
+     * Callback prototype that notify when the player added new attachments to
      * the current media.
      *
      * \note It can be called several times for one playback. The array
@@ -556,7 +556,7 @@ struct libvlc_media_player_cbs
      * available since version 0
      *
      * \param opaque opaque pointer set by libvlc_media_player_new()
-     * \param new_volume volume in the range [0;2.f]
+     * \param volume volume in the range [0;2.f]
      */
     void (*on_audio_volume_changed)( void *opaque, float volume );
 
@@ -711,7 +711,7 @@ LIBVLC_API bool libvlc_media_player_is_playing(libvlc_media_player_t *p_mi);
  * Play
  *
  * \param p_mi the Media Player
- * \return 0 if playback started (and was already started), or -1 on error.
+ * \return 0 if playback started (or was already started), or -1 on error.
  */
 LIBVLC_API int libvlc_media_player_play ( libvlc_media_player_t *p_mi );
 
@@ -2070,7 +2070,7 @@ LIBVLC_API libvlc_media_track_t *
 libvlc_media_player_get_selected_track( libvlc_media_player_t *p_mi,
                                         libvlc_track_type_t type );
 
-/*
+/**
  * Get a track from a track id
  *
  * \version LibVLC 4.0.0 and later.


=====================================
include/vlc/libvlc_parser.h
=====================================
@@ -332,7 +332,7 @@ struct libvlc_thumbnailer_request_t
          */
         libvlc_thumbnailer_seek_value_t value;
 
-        /** precise or fast mode (libvlc_thumbnailer_seek_fast by default) */
+        /** precise or fast mode (libvlc_media_thumbnail_seek_precise by default) */
         libvlc_thumbnailer_seek_speed_t speed;
     } seek;
 


=====================================
include/vlc/libvlc_renderer_discoverer.h
=====================================
@@ -192,7 +192,7 @@ libvlc_renderer_discoverer_new( libvlc_instance_t *p_inst,
                                 void *cbs_opaque );
 
 /**
- * Release a renderer discoverer object
+ * Destroy a renderer discoverer object
  *
  * \version LibVLC 4.0.0 or later
  *



View it on GitLab: https://code.videolan.org/videolan/vlc/-/commit/be168d904950456325e20873332789f9b6494912

-- 
View it on GitLab: https://code.videolan.org/videolan/vlc/-/commit/be168d904950456325e20873332789f9b6494912
You're receiving this email because of your account on code.videolan.org. Manage all notifications: https://code.videolan.org/-/profile/notifications | Help: https://code.videolan.org/help