Browse Source

libvlc_media_player.h: fix doxygen comments

- \param is used to declare a parameter, so \p should be used to
   reference them.
 - `type` parameter didn't exist.
 - `opaque` parameter was named `data`
 - \return for void functions is not correct. Moving the notice to a
   \bug reference.
 - \see used instead of \ref.
pull/127/head
Alexandre Janniaux 5 years ago
committed by Jean-Baptiste Kempf
parent
commit
e0916c4662
  1. 12
      include/vlc/libvlc_media_player.h

12
include/vlc/libvlc_media_player.h

@ -757,7 +757,7 @@ typedef bool( *libvlc_video_output_select_plane_cb )( void *opaque, size_t plane
* \param select_plane_cb callback to select different D3D11 rendering targets
* \param opaque private pointer passed to callbacks
*
* \note the \param setup_cb and \param cleanup_cb may be called more than once per
* \note the \p setup_cb and \p cleanup_cb may be called more than once per
* playback.
*
* \retval true engine selected and callbacks set
@ -1050,7 +1050,7 @@ typedef int (*libvlc_audio_setup_cb)(void **opaque, char *format, unsigned *rate
* This is called when the media player no longer needs an audio output.
* \param opaque data pointer as passed to libvlc_audio_set_callbacks() [IN]
*/
typedef void (*libvlc_audio_cleanup_cb)(void *data);
typedef void (*libvlc_audio_cleanup_cb)(void *opaque);
/**
* Sets decoded audio format via callbacks.
@ -1596,7 +1596,6 @@ libvlc_media_player_get_program_from_id( libvlc_media_player_t *p_mi, int i_grou
* specific programs.
*
* \param p_mi the media player
* \param type type of the program list to request
*
* \return a valid libvlc_media_programlist_t or NULL in case of error or empty
* list, delete with libvlc_media_programlist_delete()
@ -2305,9 +2304,12 @@ LIBVLC_API void libvlc_audio_output_device_list_release(
* \param mp media player
* \param module If NULL, current audio output module.
* if non-NULL, name of audio output module
(\see libvlc_audio_output_t)
(see \ref libvlc_audio_output_t::psz_name)
* \param device_id device identifier string
* \return Nothing. Errors are ignored (this is a design bug).
* (see \ref libvlc_audio_output_device_t::psz_device)
*
* \bug This function returns nothing. Errors are ignored (this is a
* design bug).
*/
LIBVLC_API void libvlc_audio_output_device_set( libvlc_media_player_t *mp,
const char *module,

Loading…
Cancel
Save