[vlc-commits] [Git][videolan/vlc][master] 3 commits: libvlc_dialog.h: fix doxygen warnings
Jean-Baptiste Kempf (@jbk)
gitlab at videolan.org
Sun Jul 9 11:35:00 UTC 2023
Jean-Baptiste Kempf pushed to branch master at VideoLAN / VLC
Commits:
c410ed6c by Alexandre Janniaux at 2023-07-09T11:06:45+00:00
libvlc_dialog.h: fix doxygen warnings
include/vlc/libvlc_dialog.h:164: warning: The following parameter of libvlc_dialog_set_callbacks(libvlc_instance_t *p_instance, const libvlc_dialog_cbs *p_cbs, void *p_data) is not documented:
parameter 'p_instance'
- - - - -
dceb592f by Alexandre Janniaux at 2023-07-09T11:06:45+00:00
libvlc_media_player.h: reference elements from doxygen
- - - - -
6aaa02f4 by Alexandre Janniaux at 2023-07-09T11:06:45+00:00
libvlc_media_player.h: fix doxygen warnings
include/vlc/libvlc_media_player.h:2516: warning: argument 'channel' of command @param is not found in the argument list of libvlc_audio_set_mixmode(libvlc_media_player_t *p_mi, libvlc_audio_output_mixmode_t mode)
include/vlc/libvlc_media_player.h:2516: warning: The following parameter of libvlc_audio_set_mixmode(libvlc_media_player_t *p_mi, libvlc_audio_output_mixmode_t mode) is not documented:
parameter 'mode'
include/vlc/libvlc_media_player.h:383: warning: argument '1' of command @param is not found in the argument list of libvlc_video_format_cb(void **opaque, char *chroma, unsigned *width, unsigned *height, unsigned *pitches, unsigned *lines)
include/vlc/libvlc_media_player.h:383: warning: argument '1' of command @param is not found in the argument list of libvlc_video_format_cb(void **opaque, char *chroma, unsigned *width, unsigned *height, unsigned *pitches, unsigned *lines)
include/vlc/libvlc_media_player.h:743: warning: argument 'report_opaque' of command @param is not found in the argument list of libvlc_video_output_mouse_move_cb(void *opaque, int x, int y)
include/vlc/libvlc_media_player.h:756: warning: argument 'report_opaque' of command @param is not found in the argument list of libvlc_video_output_mouse_press_cb(void *opaque, libvlc_video_output_mouse_button_t button)
include/vlc/libvlc_media_player.h:767: warning: argument 'report_opaque' of command @param is not found in the argument list of libvlc_video_output_mouse_release_cb(void *opaque, libvlc_video_output_mouse_button_t button)
include/vlc/libvlc_media_player.h:787: warning: unable to resolve reference to 'libvlc_video_output_set_resize_cb' for \ref command
include/vlc/libvlc_media_player.h:798: warning: unable to resolve reference to 'report_size_change' for \ref command
include/vlc/libvlc_media_player.h:834: warning: argument 'resize_cb' of command @param is not found in the argument list of libvlc_video_set_output_callbacks(libvlc_media_player_t *mp, libvlc_video_engine_t engine, libvlc_video_output_setup_cb setup_cb, libvlc_video_output_cleanup_cb cleanup_cb, libvlc_video_output_set_window_cb window_cb, libvlc_video_update_output_cb update_output_cb, libvlc_video_swap_cb swap_cb, libvlc_video_makeCurrent_cb makeCurrent_cb, libvlc_video_getProcAddress_cb getProcAddress_cb, libvlc_video_frameMetadata_cb metadata_cb, libvlc_video_output_select_plane_cb select_plane_cb, void *opaque)
include/vlc/libvlc_media_player.h:834: warning: The following parameter of libvlc_video_set_output_callbacks(libvlc_media_player_t *mp, libvlc_video_engine_t engine, libvlc_video_output_setup_cb setup_cb, libvlc_video_output_cleanup_cb cleanup_cb, libvlc_video_output_set_window_cb window_cb, libvlc_video_update_output_cb update_output_cb, libvlc_video_swap_cb swap_cb, libvlc_video_makeCurrent_cb makeCurrent_cb, libvlc_video_getProcAddress_cb getProcAddress_cb, libvlc_video_frameMetadata_cb metadata_cb, libvlc_video_output_select_plane_cb select_plane_cb, void *opaque) is not documented:
parameter 'window_cb'
- - - - -
2 changed files:
- include/vlc/libvlc_dialog.h
- include/vlc/libvlc_media_player.h
Changes:
=====================================
include/vlc/libvlc_dialog.h
=====================================
@@ -165,6 +165,7 @@ typedef void (*libvlc_dialog_error_cbs)(void *p_data, const char *psz_title, con
*
* @version LibVLC 3.0.0 and later.
*
+ * @param p_instance the libvlc instance to attach the dialog callbacks to
* @param p_cbs a pointer to callbacks, or NULL to unregister callbacks.
* @param p_data opaque pointer for the callback
*/
=====================================
include/vlc/libvlc_media_player.h
=====================================
@@ -396,8 +396,8 @@ typedef void (*libvlc_video_display_cb)(void *opaque, void *picture);
* \return the number of picture buffers allocated, 0 indicates failure
*
* \version LibVLC 4.0.0 and later.
- * \param[in] (width+1) - pointer to display width in pixels
- * \param[in] (height+1) - pointer to display height in pixels
+ * \param[in] width pointer to display width - 1 in pixels
+ * \param[in] height pointer to display height - 1 in pixels
*
* \note
* For each pixels plane, the scanline pitch must be bigger than or equal to
@@ -745,7 +745,7 @@ typedef enum libvlc_video_output_mouse_button_t {
* The position (0,0) denotes the top left corner, bottom right corner position
* is (width,height) as reported by \ref libvlc_video_output_resize_cb.
*
- * \param report_opaque parameter passed to \ref libvlc_video_output_set_window_cb. [IN]
+ * \param opaque parameter passed to \ref libvlc_video_output_set_window_cb. [IN]
* \param x horizontal mouse positon in \ref libvlc_video_output_resize_cb coordinates. [IN]
* \param y vertical mouse positon in \ref libvlc_video_output_resize_cb coordinates. [IN]
*/
@@ -757,7 +757,7 @@ typedef void (*libvlc_video_output_mouse_move_cb)(void *opaque, int x, int y);
*
* The button event will be reported at the last position provided by \ref libvlc_video_output_mouse_move_cb
*
- * \param report_opaque parameter passed to \ref libvlc_video_output_set_window_cb. [IN]
+ * \param opaque parameter passed to \ref libvlc_video_output_set_window_cb. [IN]
* \param button represent the button pressed, see \ref libvlc_video_output_mouse_button_t for available buttons. [IN]
*/
typedef void (*libvlc_video_output_mouse_press_cb)(void *opaque, libvlc_video_output_mouse_button_t button);
@@ -768,7 +768,7 @@ typedef void (*libvlc_video_output_mouse_press_cb)(void *opaque, libvlc_video_ou
*
* The button event will be reported at the last position provided by \ref libvlc_video_output_mouse_move_cb.
*
- * \param report_opaque parameter passed to \ref libvlc_video_output_set_window_cb. [IN]
+ * \param opaque parameter passed to \ref libvlc_video_output_set_window_cb. [IN]
* \param button represent the button released, see \ref libvlc_video_output_mouse_button_t for available buttons. [IN]
*/
typedef void (*libvlc_video_output_mouse_release_cb)(void *opaque, libvlc_video_output_mouse_button_t button);
@@ -784,10 +784,10 @@ typedef void (*libvlc_video_output_mouse_release_cb)(void *opaque, libvlc_video_
*
* \param[in] opaque private pointer set on the opaque parameter of @a libvlc_video_output_setup_cb()
* \param[in] report_size_change callback which must be called when the host size changes.
- * The callback is valid until another call to \ref libvlc_video_output_set_resize_cb
+ * The callback is valid until another call to \ref libvlc_video_output_set_window_cb
* is done. This may be called from any thread.
* \param[in] report_mouse_move callback which must be called when the mouse position change on the video surface.
- * The coordinates are relative to the size reported through the report_size_change.
+ * The coordinates are relative to the size reported through the \p report_size_change.
* This may be called from any thread.
* \param[in] report_mouse_pressed callback which must be called when a mouse button is pressed on the video surface,
* The position of the event is the last position reported by the report_mouse_move callback. This may be
@@ -795,7 +795,7 @@ typedef void (*libvlc_video_output_mouse_release_cb)(void *opaque, libvlc_video_
* \param[in] report_mouse_released callback which must be called when a mouse button is released on the video surface,
* The position of the event is the last position reported by the report_mouse_move callback. This may be
* called from any thread.
- * \param[in] report_opaque private pointer to pass to the \ref report_size_change callback.
+ * \param[in] report_opaque private pointer to pass to the \p report_size_change callback.
*/
typedef void( *libvlc_video_output_set_window_cb )( void *opaque,
libvlc_video_output_resize_cb report_size_change,
@@ -840,7 +840,7 @@ typedef bool( *libvlc_video_output_select_plane_cb )( void *opaque, size_t plane
* \param engine the GPU engine to use
* \param setup_cb callback called to initialize user data
* \param cleanup_cb callback called to clean up user data
- * \param resize_cb callback to set the resize callback
+ * \param window_cb callback called to setup the window
* \param update_output_cb callback to get the rendering format of the host (cannot be NULL)
* \param swap_cb callback called after rendering a video frame (cannot be NULL)
* \param makeCurrent_cb callback called to enter/leave the rendering context (cannot be NULL)
@@ -2494,7 +2494,7 @@ LIBVLC_API libvlc_audio_output_stereomode_t libvlc_audio_get_stereomode( libvlc_
* Set current audio stereo-mode.
*
* \param p_mi media player
- * \param channel the audio stereo-mode, \see libvlc_audio_output_stereomode_t
+ * \param mode the audio stereo-mode, \see libvlc_audio_output_stereomode_t
* \return 0 on success, -1 on error
* \version LibVLC 4.0.0 or later
*/
@@ -2513,7 +2513,7 @@ LIBVLC_API libvlc_audio_output_mixmode_t libvlc_audio_get_mixmode( libvlc_media_
/**
* Set current audio mix-mode.
*
- * By default (libvlc_AudioMixMode_Unset), the audio output will keep its
+ * By default (::libvlc_AudioMixMode_Unset), the audio output will keep its
* original channel configuration (play stereo as stereo, or 5.1 as 5.1). Yet,
* the OS and Audio API might refuse a channel configuration and asks VLC to
* adapt (Stereo played as 5.1 or vice-versa).
@@ -2521,14 +2521,14 @@ LIBVLC_API libvlc_audio_output_mixmode_t libvlc_audio_get_mixmode( libvlc_media_
* This function allows to force a channel configuration, it will only work if
* the OS and Audio API accept this configuration (otherwise, it won't have any
* effects). Here are some examples:
- * - Play multi-channels (5.1, 7.1...) as stereo (libvlc_AudioMixMode_Stereo)
- * - Play Stereo or 5.1 as 7.1 (libvlc_AudioMixMode_7_1)
+ * - Play multi-channels (5.1, 7.1...) as stereo (::libvlc_AudioMixMode_Stereo)
+ * - Play Stereo or 5.1 as 7.1 (::libvlc_AudioMixMode_7_1)
* - Play multi-channels as stereo with a binaural effect
- * (libvlc_AudioMixMode_Binaural). It might be selected automatically if the
+ * (::libvlc_AudioMixMode_Binaural). It might be selected automatically if the
* OS and Audio API can detect if a headphone is plugged.
*
* \param p_mi media player
- * \param channel the audio mix-mode, \see libvlc_audio_output_mixmode_t
+ * \param mode the audio mix-mode, \see libvlc_audio_output_mixmode_t
* \return 0 on success, -1 on error
* \version LibVLC 4.0.0 or later
*/
View it on GitLab: https://code.videolan.org/videolan/vlc/-/compare/301cef1b6c315c74eda2d0f46af753ad13404f71...6aaa02f4e8ccfe93ceef5c271081be0f397b2788
--
View it on GitLab: https://code.videolan.org/videolan/vlc/-/compare/301cef1b6c315c74eda2d0f46af753ad13404f71...6aaa02f4e8ccfe93ceef5c271081be0f397b2788
You're receiving this email because of your account on code.videolan.org.
VideoLAN code repository instance
More information about the vlc-commits
mailing list