[vlc-commits] [Git][videolan/vlc][master] 15 commits: vlc_stream_extractor: add argument name
Jean-Baptiste Kempf (@jbk)
gitlab at videolan.org
Wed Apr 13 03:06:52 UTC 2022
Jean-Baptiste Kempf pushed to branch master at VideoLAN / VLC
Commits:
f81c936c by Marvin Scholz at 2022-04-13T02:51:32+00:00
vlc_stream_extractor: add argument name
This is needed so that doxygen can properly generate
documentation without producing a warning due to the
missing param name.
- - - - -
60bbc4a2 by Marvin Scholz at 2022-04-13T02:51:32+00:00
vlc_stream_extractor: doc: capitalize warning
Makes it consistent with how it is done in most other
places and looks nicer in the generated documentation.
- - - - -
b430bdff by Marvin Scholz at 2022-04-13T02:51:32+00:00
stream_extractor: doc: properly refer to arguments
Instead of \ref, to refer to parameters, \p should be
used.
- - - - -
bd5021f3 by Marvin Scholz at 2022-04-13T02:51:32+00:00
mrl_helpers: doc: fix link to MRL specification
- - - - -
964b31df by Marvin Scholz at 2022-04-13T02:51:32+00:00
vlc_vout_display: doc: fix references
To properly refer to the callbacks, which are in a different structure,
the struct or type name they belong to must be given.
- - - - -
26806b39 by Marvin Scholz at 2022-04-13T02:51:32+00:00
stream: remove type prefix from data argument name
None of the other functions in this file or even in the same
function signature use this style.
- - - - -
6193739b by Marvin Scholz at 2022-04-13T02:51:32+00:00
stream: doc: stream_extractor_AttachParsed fixes
- Rename the source argument to stream, which is the actual name of
the argument.
- Add documentation for the data argument
- Add missing group, without this doxygen would list it twice in
places like search, leading to some confusion.
- - - - -
52e9ec8f by Marvin Scholz at 2022-04-13T02:51:32+00:00
vlc_vout_display: doc: fix broken references
- - - - -
c5a2875d by Marvin Scholz at 2022-04-13T02:51:32+00:00
vlc_vout_window: doc: add missing param docs
- - - - -
38a2fa49 by Marvin Scholz at 2022-04-13T02:51:32+00:00
access/http: doc: add some missing param docs
- - - - -
c5cace07 by Marvin Scholz at 2022-04-13T02:51:32+00:00
vlc_vector: doc: fix in/out annotations
The in, out, in,out annotations need to be right after \param
for doxygen to properly parse them.
- - - - -
6372016e by Marvin Scholz at 2022-04-13T02:51:32+00:00
libvlc_media_player: doc: fix refs and in/out annotations
- - - - -
bc298c29 by Marvin Scholz at 2022-04-13T02:51:32+00:00
rtp/xiph: doc: fix file name
- - - - -
74e133ae by Marvin Scholz at 2022-04-13T02:51:32+00:00
include/deprecated: doc: fix sections
Only add the functions to the sections they should be in
not to the parent section too.
- - - - -
c8d2923e by Marvin Scholz at 2022-04-13T02:51:32+00:00
vlc_vout_window: doc: add section for event reporting
This groups all event reporting functions so its much easier to
see all event reporting related functions that a window provider
might need to call in one place.Additionally makes it clearer
that those are not meant to be called by modules other than the
window provider implementation.
- - - - -
13 changed files:
- include/vlc/deprecated.h
- include/vlc/libvlc_media_player.h
- include/vlc_stream_extractor.h
- include/vlc_vector.h
- include/vlc_vout_display.h
- include/vlc_vout_window.h
- modules/access/http/file.h
- modules/access/http/message.h
- modules/access/http/outfile.h
- modules/access/rtp/xiph.c
- src/input/mrl_helpers.h
- src/input/stream.h
- src/input/stream_extractor.c
Changes:
=====================================
include/vlc/deprecated.h
=====================================
@@ -29,7 +29,7 @@ extern "C" {
# endif
/**
- * \ingroup libvlc libvlc_media
+ * \ingroup libvlc_media
* @{
*/
@@ -124,7 +124,7 @@ void libvlc_media_tracks_release( libvlc_media_track_t **p_tracks,
/** @}*/
/**
- * \ingroup libvlc libvlc_media_player
+ * \ingroup libvlc_media_player
* @{
*/
@@ -151,7 +151,7 @@ LIBVLC_DEPRECATED LIBVLC_API void libvlc_track_description_list_release( libvlc_
/** @}*/
/**
- * \ingroup libvlc libvlc_video
+ * \ingroup libvlc_video
* @{
*/
@@ -229,7 +229,7 @@ LIBVLC_DEPRECATED LIBVLC_API int libvlc_video_set_spu( libvlc_media_player_t *p_
/** @}*/
/**
- * \ingroup libvlc libvlc_audio
+ * \ingroup libvlc_audio
* @{
*/
=====================================
include/vlc/libvlc_media_player.h
=====================================
@@ -337,9 +337,9 @@ typedef enum libvlc_video_transfer_func_t {
* adequate dimensions must be returned via the second parameter. Those
* planes must be aligned on 32-bytes boundaries.
*
- * \param opaque private pointer as passed to libvlc_video_set_callbacks() [IN]
- * \param planes start address of the pixel planes (LibVLC allocates the array
- * of void pointers, this callback must initialize the array) [OUT]
+ * \param[in] opaque private pointer as passed to libvlc_video_set_callbacks()
+ * \param[out] planes start address of the pixel planes (LibVLC allocates the array
+ * of void pointers, this callback must initialize the array)
* \return a private pointer for the display and unlock callbacks to identify
* the picture buffers
*/
@@ -355,11 +355,11 @@ typedef void *(*libvlc_video_lock_cb)(void *opaque, void **planes);
* \note A picture buffer is unlocked after the picture is decoded,
* but before the picture is displayed.
*
- * \param opaque private pointer as passed to libvlc_video_set_callbacks() [IN]
- * \param picture private pointer returned from the @ref libvlc_video_lock_cb
- * callback [IN]
- * \param planes pixel planes as defined by the @ref libvlc_video_lock_cb
- * callback (this parameter is only for convenience) [IN]
+ * \param[in] opaque private pointer as passed to libvlc_video_set_callbacks()
+ * \param[in] picture private pointer returned from the @ref libvlc_video_lock_cb
+ * callback
+ * \param[in] planes pixel planes as defined by the @ref libvlc_video_lock_cb
+ * callback (this parameter is only for convenience)
*/
typedef void (*libvlc_video_unlock_cb)(void *opaque, void *picture,
void *const *planes);
@@ -370,9 +370,9 @@ typedef void (*libvlc_video_unlock_cb)(void *opaque, void *picture,
* When the video frame needs to be shown, as determined by the media playback
* clock, the display callback is invoked.
*
- * \param opaque private pointer as passed to libvlc_video_set_callbacks() [IN]
- * \param picture private pointer returned from the @ref libvlc_video_lock_cb
- * callback [IN]
+ * \param[in] opaque private pointer as passed to libvlc_video_set_callbacks()
+ * \param[in] picture private pointer returned from the @ref libvlc_video_lock_cb
+ * callback
*/
typedef void (*libvlc_video_display_cb)(void *opaque, void *picture);
@@ -383,19 +383,19 @@ typedef void (*libvlc_video_display_cb)(void *opaque, void *picture);
* as it needs. In that case, LibVLC will attempt to convert the video format
* (rescaling and chroma conversion) but these operations can be CPU intensive.
*
- * \param opaque pointer to the private pointer passed to
- * libvlc_video_set_callbacks() [IN/OUT]
- * \param chroma pointer to the 4 bytes video format identifier [IN/OUT]
- * \param width pointer to the buffer width in pixels[IN/OUT]
- * \param height pointer to the buffer height in pixels[IN/OUT]
- * \param pitches table of scanline pitches in bytes for each pixel plane
- * (the table is allocated by LibVLC) [OUT]
- * \param lines table of scanlines count for each plane [OUT]
+ * \param[in,out] opaque pointer to the private pointer passed to
+ * libvlc_video_set_callbacks()
+ * \param[in,out] chroma pointer to the 4 bytes video format identifier
+ * \param[in,out] width pointer to the buffer width in pixels
+ * \param[in,out] height pointer to the buffer height in pixels
+ * \param[out] pitches table of scanline pitches in bytes for each pixel plane
+ * (the table is allocated by LibVLC)
+ * \param[out] lines table of scanlines count for each plane
* \return the number of picture buffers allocated, 0 indicates failure
*
* \version LibVLC 4.0.0 and later.
- * \param (width+1) - pointer to display width in pixels[IN]
- * \param (height+1) - pointer to display height in pixels[IN]
+ * \param[in] (width+1) - pointer to display width in pixels
+ * \param[in] (height+1) - pointer to display height in pixels
*
* \note
* For each pixels plane, the scanline pitch must be bigger than or equal to
@@ -414,8 +414,8 @@ typedef unsigned (*libvlc_video_format_cb)(void **opaque, char *chroma,
/**
* Callback prototype to configure picture buffers format.
*
- * \param opaque private pointer as passed to libvlc_video_set_format_callbacks()
- * (and possibly modified by @ref libvlc_video_format_cb) [IN]
+ * \param[in] opaque private pointer as passed to libvlc_video_set_format_callbacks()
+ * (and possibly modified by @ref libvlc_video_format_cb)
*/
typedef void (*libvlc_video_cleanup_cb)(void *opaque);
@@ -523,12 +523,11 @@ typedef struct libvlc_video_setup_device_info_t
* Callback prototype called to initialize user data.
* Setup the rendering environment.
*
- * \param opaque private pointer passed to the @a libvlc_video_set_output_callbacks()
+ * \param[in,out] opaque private pointer passed to the @a libvlc_video_set_output_callbacks()
* on input. The callback can change this value on output to be
* passed to all the other callbacks set on @a libvlc_video_set_output_callbacks().
- * [IN/OUT]
- * \param cfg requested configuration of the video device [IN]
- * \param out libvlc_video_setup_device_info_t* to fill [OUT]
+ * \param[in] cfg requested configuration of the video device
+ * \param[out] out libvlc_video_setup_device_info_t* to fill
* \return true on success
* \version LibVLC 4.0.0 or later
*
@@ -553,7 +552,7 @@ typedef bool (*libvlc_video_output_setup_cb)(void **opaque,
/**
* Callback prototype called to release user data
*
- * \param opaque private pointer set on the opaque parameter of @a libvlc_video_output_setup_cb() [IN]
+ * \param[in] opaque private pointer set on the opaque parameter of @a libvlc_video_output_setup_cb()
* \version LibVLC 4.0.0 or later
*/
typedef void (*libvlc_video_output_cleanup_cb)(void* opaque);
@@ -608,9 +607,9 @@ typedef struct libvlc_video_output_cfg_t
* Callback prototype called on video size changes.
* Update the rendering output setup.
*
- * \param opaque private pointer set on the opaque parameter of @a libvlc_video_output_setup_cb() [IN]
- * \param cfg configuration of the video that will be rendered [IN]
- * \param output configuration describing with how the rendering is setup [OUT]
+ * \param[in] opaque private pointer set on the opaque parameter of @a libvlc_video_output_setup_cb()
+ * \param[in] cfg configuration of the video that will be rendered
+ * \param[out] output configuration describing with how the rendering is setup
* \version LibVLC 4.0.0 or later
*
* \note the configuration device for Direct3D9 is the IDirect3DDevice9 that VLC
@@ -631,7 +630,7 @@ typedef bool (*libvlc_video_update_output_cb)(void* opaque, const libvlc_video_r
* This callback is called outside of libvlc_video_makeCurrent_cb current/not-current
* calls.
*
- * \param opaque private pointer set on the opaque parameter of @a libvlc_video_output_setup_cb() [IN]
+ * \param[in] opaque private pointer set on the opaque parameter of @a libvlc_video_output_setup_cb()
* \version LibVLC 4.0.0 or later
*/
typedef void (*libvlc_video_swap_cb)(void* opaque);
@@ -640,13 +639,13 @@ typedef void (*libvlc_video_swap_cb)(void* opaque);
* Callback prototype to set up the OpenGL context for rendering.
* Tell the host the rendering is about to start/has finished.
*
- * \param opaque private pointer set on the opaque parameter of @a libvlc_video_output_setup_cb() [IN]
- * \param enter true to set the context as current, false to unset it [IN]
+ * \param[in] opaque private pointer set on the opaque parameter of @a libvlc_video_output_setup_cb()
+ * \param[in] enter true to set the context as current, false to unset it
* \return true on success
* \version LibVLC 4.0.0 or later
*
* On Direct3D11 the following may change on the provided ID3D11DeviceContext*
- * between \ref enter being true and \ref enter being false:
+ * between \p enter being true and \p enter being false:
* - IASetPrimitiveTopology()
* - IASetInputLayout()
* - IASetVertexBuffers()
@@ -665,7 +664,7 @@ typedef bool (*libvlc_video_makeCurrent_cb)(void* opaque, bool enter);
/**
* Callback prototype to load opengl functions
*
- * \param opaque private pointer set on the opaque parameter of @a libvlc_video_output_setup_cb() [IN]
+ * \param[in] opaque private pointer set on the opaque parameter of @a libvlc_video_output_setup_cb()
* \param fct_name name of the opengl function to load
* \return a pointer to the named OpenGL function the NULL otherwise
* \version LibVLC 4.0.0 or later
@@ -692,9 +691,9 @@ typedef enum libvlc_video_metadata_type_t {
/**
* Callback prototype to receive metadata before rendering.
*
- * \param opaque private pointer passed to the @a libvlc_video_set_output_callbacks() [IN]
- * \param type type of data passed in metadata [IN]
- * \param metadata the type of metadata [IN]
+ * \param[in] opaque private pointer passed to the @a libvlc_video_set_output_callbacks()
+ * \param[in] type type of data passed in metadata
+ * \param[in] metadata the type of metadata
* \version LibVLC 4.0.0 or later
*/
typedef void (*libvlc_video_frameMetadata_cb)(void* opaque, libvlc_video_metadata_type_t type, const void *metadata);
@@ -733,11 +732,11 @@ typedef void( *libvlc_video_output_resize_cb )( void *report_opaque, unsigned wi
*
* It may be called before the \ref libvlc_video_output_setup_cb callback.
*
- * \param opaque private pointer set on the opaque parameter of @a libvlc_video_output_setup_cb() [IN]
- * \param report_size_change callback which must be called when the host size changes. [IN]
- * The callback is valid until another call to \ref libvlc_video_output_set_resize_cb
- * is done. This may be called from any thread.
- * \param report_opaque private pointer to pass to the \ref report_size_change callback. [IN]
+ * \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
+ * is done. This may be called from any thread.
+ * \param[in] report_opaque private pointer to pass to the \ref report_size_change callback.
*/
typedef void( *libvlc_video_output_set_resize_cb )( void *opaque,
libvlc_video_output_resize_cb report_size_change,
@@ -745,7 +744,7 @@ typedef void( *libvlc_video_output_set_resize_cb )( void *opaque,
/** Tell the host the rendering for the given plane is about to start
*
- * \param opaque private pointer set on the opaque parameter of @a libvlc_video_output_setup_cb() [IN]
+ * \param[in] opaque private pointer set on the opaque parameter of @a libvlc_video_output_setup_cb()
* \param plane number of the rendering plane to select
* \param output handle of the rendering output for the given plane
* \return true on success
@@ -957,8 +956,8 @@ LIBVLC_API void libvlc_media_player_set_android_context( libvlc_media_player_t *
* track sampling rate is 48000 Hz, then 1200 samples represent 25 milliseconds
* of audio signal - regardless of the number of audio channels.
*
- * \param data data pointer as passed to libvlc_audio_set_callbacks() [IN]
- * \param samples pointer to a table of audio samples to play back [IN]
+ * \param[in] data data pointer as passed to libvlc_audio_set_callbacks()
+ * \param[in] samples pointer to a table of audio samples to play back
* \param count number of audio samples to play back
* \param pts expected play time stamp (see libvlc_delay())
*/
@@ -971,7 +970,7 @@ typedef void (*libvlc_audio_play_cb)(void *data, const void *samples,
* LibVLC invokes this callback to pause audio playback.
*
* \note The pause callback is never called if the audio is already paused.
- * \param data data pointer as passed to libvlc_audio_set_callbacks() [IN]
+ * \param[in] data data pointer as passed to libvlc_audio_set_callbacks()
* \param pts time stamp of the pause request (should be elapsed already)
*/
typedef void (*libvlc_audio_pause_cb)(void *data, int64_t pts);
@@ -983,7 +982,7 @@ typedef void (*libvlc_audio_pause_cb)(void *data, int64_t pts);
* previously paused.
*
* \note The resume callback is never called if the audio is not paused.
- * \param data data pointer as passed to libvlc_audio_set_callbacks() [IN]
+ * \param[in] data data pointer as passed to libvlc_audio_set_callbacks()
* \param pts time stamp of the resumption request (should be elapsed already)
*/
typedef void (*libvlc_audio_resume_cb)(void *data, int64_t pts);
@@ -995,7 +994,7 @@ typedef void (*libvlc_audio_resume_cb)(void *data, int64_t pts);
* stop playback as soon as possible. This typically occurs when the media is
* stopped.
*
- * \param data data pointer as passed to libvlc_audio_set_callbacks() [IN]
+ * \param[in] data data pointer as passed to libvlc_audio_set_callbacks()
*/
typedef void (*libvlc_audio_flush_cb)(void *data, int64_t pts);
@@ -1006,13 +1005,13 @@ typedef void (*libvlc_audio_flush_cb)(void *data, int64_t pts);
* There will be no further decoded samples for the track, but playback should
* nevertheless continue until all already pending buffers are rendered.
*
- * \param data data pointer as passed to libvlc_audio_set_callbacks() [IN]
+ * \param[in] data data pointer as passed to libvlc_audio_set_callbacks()
*/
typedef void (*libvlc_audio_drain_cb)(void *data);
/**
* Callback prototype for audio volume change.
- * \param data data pointer as passed to libvlc_audio_set_callbacks() [IN]
+ * \param[in] data data pointer as passed to libvlc_audio_set_callbacks()
* \param volume software volume (1. = nominal, 0. = mute)
* \param mute muted flag
*/
@@ -1065,11 +1064,11 @@ void libvlc_audio_set_volume_callback( libvlc_media_player_t *mp,
* Callback prototype to setup the audio playback.
*
* This is called when the media player needs to create a new audio output.
- * \param opaque pointer to the data pointer passed to
- * libvlc_audio_set_callbacks() [IN/OUT]
- * \param format 4 bytes sample format [IN/OUT]
- * \param rate sample rate [IN/OUT]
- * \param channels channels count [IN/OUT]
+ * \param[in,out] opaque pointer to the data pointer passed to
+ * libvlc_audio_set_callbacks()
+ * \param[in,out] format 4 bytes sample format
+ * \param[in,out] rate sample rate
+ * \param[in,out] channels channels count
* \return 0 on success, anything else to skip audio playback
*/
typedef int (*libvlc_audio_setup_cb)(void **opaque, char *format, unsigned *rate,
@@ -1079,7 +1078,7 @@ typedef int (*libvlc_audio_setup_cb)(void **opaque, char *format, unsigned *rate
* Callback prototype for audio playback cleanup.
*
* 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]
+ * \param[in] opaque data pointer as passed to libvlc_audio_set_callbacks()
*/
typedef void (*libvlc_audio_cleanup_cb)(void *opaque);
@@ -1730,8 +1729,8 @@ void libvlc_video_set_mouse_input( libvlc_media_player_t *p_mi, unsigned on );
*
* \param p_mi media player
* \param num number of the video (starting from, and most commonly 0)
- * \param px pointer to get the pixel width [OUT]
- * \param py pointer to get the pixel height [OUT]
+ * \param[out] px pointer to get the pixel width
+ * \param[out] py pointer to get the pixel height
* \return 0 on success, -1 if the specified video does not exist
*/
LIBVLC_API
@@ -1756,8 +1755,8 @@ int libvlc_video_get_size( libvlc_media_player_t *p_mi, unsigned num,
*
* \param p_mi media player
* \param num number of the video (starting from, and most commonly 0)
- * \param px pointer to get the abscissa [OUT]
- * \param py pointer to get the ordinate [OUT]
+ * \param[out] px pointer to get the abscissa
+ * \param[out] py pointer to get the ordinate
* \return 0 on success, -1 if the specified video does not exist
*/
LIBVLC_API
@@ -1894,9 +1893,9 @@ LIBVLC_API int libvlc_video_set_spu_delay( libvlc_media_player_t *p_mi, int64_t
* \version LibVLC 3.0.0 and later.
*
* \param p_mi the media player
- * \param titles address to store an allocated array of title descriptions
- * descriptions (must be freed with libvlc_title_descriptions_release()
- * by the caller) [OUT]
+ * \param[out] titles address to store an allocated array of title descriptions
+ * descriptions (must be freed with libvlc_title_descriptions_release()
+ * by the caller)
*
* \return the number of titles (-1 on error)
*/
@@ -1922,9 +1921,9 @@ LIBVLC_API
*
* \param p_mi the media player
* \param i_chapters_of_title index of the title to query for chapters (uses current title if set to -1)
- * \param pp_chapters address to store an allocated array of chapter descriptions
- * descriptions (must be freed with libvlc_chapter_descriptions_release()
- * by the caller) [OUT]
+ * \param[out] pp_chapters address to store an allocated array of chapter descriptions
+ * descriptions (must be freed with libvlc_chapter_descriptions_release()
+ * by the caller)
*
* \return the number of chapters (-1 on error)
*/
=====================================
include/vlc_stream_extractor.h
=====================================
@@ -119,14 +119,14 @@ VLC_USED;
* this function will only be invoked within `pf_readdir` in order to
* get the virtual path of the listed items.
*
- * \warning the returned value is to be freed by the caller
+ * \warning The returned value is to be freed by the caller
*
* \param extractor the stream_directory_t for which the entity belongs
* \param subentry the name of the entity in question
*
* \return a pointer to the resulting MRL on success, NULL on failure
**/
-VLC_API char* vlc_stream_extractor_CreateMRL( stream_directory_t*,
+VLC_API char* vlc_stream_extractor_CreateMRL( stream_directory_t *extractor,
char const* subentry );
/**
=====================================
include/vlc_vector.h
=====================================
@@ -159,8 +159,8 @@ vlc_vector_enforce_size_t_(size_t value)
* \param ptr the current data to realloc
* \param count the requested capacity, in number of items
* \param size the size of one item
- * \param pcap a pointer to the `cap` field of the vector [IN/OUT]
- * \param psize a pointer to the `size` field of the vector [IN/OUT]
+ * \param[in,out] pcap a pointer to the `cap` field of the vector
+ * \param[in,out] psize a pointer to the `size` field of the vector
* \return the reallocated array, or `ptr` if reallocation failed
*/
static inline void *
@@ -609,7 +609,7 @@ vlc_vector_move_(char *array, size_t index, size_t count, size_t target)
*
* \param pv a pointer to the vector
* \param item the item to find (compared with ==)
- * \param a pointer to the result (ssize_t *) [OUT]
+ * \param[out] pidx a pointer to the result (ssize_t *)
*/
#define vlc_vector_index_of(pv, item, pidx) \
do { \
@@ -630,8 +630,8 @@ vlc_vector_move_(char *array, size_t index, size_t count, size_t target)
* Use only for vectors of primitive types or pointers (every struct would be
* copied for a vector of structs).
*
- * \param item the iteration variable [OUT]
- * \param pv a pointer to the vector [OUT]
+ * \param[out] item the iteration variable
+ * \param[out] pv a pointer to the vector
*/
#define vlc_vector_foreach(item, pv) \
for (size_t vlc_vector_idx_##item = 0; \
=====================================
include/vlc_vout_display.h
=====================================
@@ -82,10 +82,10 @@ typedef struct vlc_video_align {
*
* This primarily controls the size of the display area within the video
* window, as follows:
- * - If \ref vout_display_cfg.is_display_filled is set,
+ * - If \ref vout_display_cfg::is_display_filled "is_display_filled" is set,
* the video size is fitted to the display size.
- * - If \ref vout_display_cfg.window size is valid, the video size is set to
- * the window size,
+ * - If \ref vout_display_cfg::window "window" size is valid, the video size
+ * is set to the window size,
* - Otherwise, the video size is determined from the original video format,
* multiplied by the zoom factor.
*/
@@ -131,7 +131,7 @@ enum vout_display_query {
* Notifies a change in display size.
*
* \retval VLC_SUCCESS if the display handled the change
- * \retval VLC_EGENERIC if a \ref vlc_display_operations.reset_pictures
+ * \retval VLC_EGENERIC if a \ref vlc_display_operations::reset_pictures
* request is necessary
*/
VOUT_DISPLAY_CHANGE_DISPLAY_SIZE,
@@ -140,7 +140,7 @@ enum vout_display_query {
* Notifies a change of the display fill display flag by the user.
*
* \retval VLC_SUCCESS if the display handled the change
- * \retval VLC_EGENERIC if a \ref vlc_display_operations.reset_pictures
+ * \retval VLC_EGENERIC if a \ref vlc_display_operations::reset_pictures
* request is necessary
*/
VOUT_DISPLAY_CHANGE_DISPLAY_FILLED,
@@ -149,7 +149,7 @@ enum vout_display_query {
* Notifies a change of the user zoom factor.
*
* \retval VLC_SUCCESS if the display handled the change
- * \retval VLC_EGENERIC if a \ref vlc_display_operations.reset_pictures
+ * \retval VLC_EGENERIC if a \ref vlc_display_operations::reset_pictures
* request is necessary
*/
VOUT_DISPLAY_CHANGE_ZOOM,
@@ -158,7 +158,7 @@ enum vout_display_query {
* Notifies a change of the sample aspect ratio.
*
* \retval VLC_SUCCESS if the display handled the change
- * \retval VLC_EGENERIC if a \ref vlc_display_operations.reset_pictures
+ * \retval VLC_EGENERIC if a \ref vlc_display_operations::reset_pictures
* request is necessary
*/
VOUT_DISPLAY_CHANGE_SOURCE_ASPECT,
@@ -166,11 +166,11 @@ enum vout_display_query {
/**
* Notifies a change of the source cropping.
*
- * The cropping requested is stored by source video_format_t::i_x/y_offset
- * and video_format_t::i_visible_width/height
+ * The cropping requested is stored by source \ref video_format_t `i_x`/`y_offset`
+ * and `i_visible_width`/`height`
*
* \retval VLC_SUCCESS if the display handled the change
- * \retval VLC_EGENERIC if a \ref vlc_display_operations.reset_pictures
+ * \retval VLC_EGENERIC if a \ref vlc_display_operations::reset_pictures
* request is necessary
*/
VOUT_DISPLAY_CHANGE_SOURCE_CROP,
@@ -329,12 +329,13 @@ struct vout_display_t {
* Picture format.
*
* This is the format of the pictures that are supplied to the
- * \ref vlc_display_operations.prepare and
- * \ref vlc_display_operations.display callbacks.
+ * \ref vlc_display_operations::prepare "prepare" and
+ * \ref vlc_display_operations::display "display" callbacks.
* Ideally, it should be identical or as close as possible as \ref source.
*
* This can only be changed from the display module activation callback,
- * or within a \ref vlc_display_operations.reset_pictures request.
+ * or within a \ref vlc_display_operations::reset_pictures "reset_pictures"
+ * request.
*
* By default, it is equal to \ref source except for the aspect ratio
* which is undefined(0) and is ignored.
=====================================
include/vlc_vout_window.h
=====================================
@@ -528,6 +528,9 @@ static inline void vout_window_SetTitle(vout_window_t *window, const char *title
*
* The window handle (vout_window_t.handle) must remain valid and constant
* while the window is enabled.
+ *
+ * \param window window to enable
+ * \param cfg initial configuration for the window
*/
VLC_API
int vout_window_Enable(vout_window_t *window);
@@ -539,10 +542,26 @@ int vout_window_Enable(vout_window_t *window);
*
* \note
* The window may be re-enabled later by a call to vout_window_Enable().
+ *
+ * \param window window to disable
*/
VLC_API
void vout_window_Disable(vout_window_t *window);
+/**
+ * \defgroup video_window_reporting Window event reporting
+ * Window provider event reporting
+ *
+ * The Window provider has to report some events to the core
+ * so that it can react appropriately to these events, for
+ * this the window provider calls the functions in this section
+ * when appropriate.
+ *
+ * \note These functions may only be called by the window provider
+ * implementation.
+ * @{
+ */
+
/**
* Reports the current window size.
*
@@ -552,6 +571,10 @@ void vout_window_Disable(vout_window_t *window);
*
* \note This function is thread-safe. In case of concurrent call, it is
* undefined which one is taken into account (but at least one is).
+ *
+ * \param window window implementation that reports the event
+ * \param width width of the usable window area in pixels
+ * \param height height of the usable window area in pixels
*/
static inline void vout_window_ReportSize(vout_window_t *window,
unsigned width, unsigned height)
@@ -564,6 +587,8 @@ static inline void vout_window_ReportSize(vout_window_t *window,
*
* This function is called by the window implementation to advise that the
* window is being closed externally, and should be disabled by the owner.
+ *
+ * \param window window implementation that reports the event
*/
static inline void vout_window_ReportClose(vout_window_t *window)
{
@@ -592,6 +617,8 @@ static inline void vout_window_ReportState(vout_window_t *window,
*
* This notifies the owner of the window that the window is windowed, i.e. not
* in full screen mode.
+ *
+ * \param wnd window implementation that reports the event
*/
VLC_API void vout_window_ReportWindowed(vout_window_t *wnd);
@@ -708,5 +735,6 @@ static inline void vout_window_ReportOutputDevice(vout_window_t *window,
window->owner.cbs->output_event(window, id, name);
}
+/** @} */
/** @} */
#endif /* VLC_VOUT_WINDOW_H */
=====================================
modules/access/http/file.h
=====================================
@@ -35,6 +35,7 @@ struct vlc_http_resource;
*
* Allocates a structure for a remote HTTP-served read-only file.
*
+ * @param mgr HTTP connection manager
* @param url URL of the file to read
* @param ua user agent string (or NULL to ignore)
* @param ref referral URL (or NULL to ignore)
=====================================
modules/access/http/message.h
=====================================
@@ -377,6 +377,9 @@ struct vlc_http_stream
* @warning The caller is responsible for reading headers at appropriate
* times as intended by the protocol. Failure to do so may result in protocol
* dead lock, and/or (HTTP 1.x) connection failure.
+ *
+ * @param s HTTP stream to read from
+ *
*/
static inline
struct vlc_http_msg *vlc_http_stream_read_headers(struct vlc_http_stream *s)
@@ -391,6 +394,7 @@ struct vlc_http_msg *vlc_http_stream_read_headers(struct vlc_http_stream *s)
*
* @todo Take a block structure rather than a byte array.
*
+ * @param s HTTP stream to write to
* @param base start address of data to write
* @param length length in bytes of data to write
* @param eos whether this is the last write on the stream
@@ -409,6 +413,7 @@ static inline ssize_t vlc_http_stream_write(struct vlc_http_stream *s,
*
* Reads the next block of data from the message payload of an HTTP stream.
*
+ * @param s HTTP stream to read from
* @return a block of data (use block_Release() to free it)
* @retval NULL The end of the stream was reached.
* @retval vlc_http_error The stream encountered a fatal error.
@@ -423,6 +428,9 @@ static inline block_t *vlc_http_stream_read(struct vlc_http_stream *s)
*
* Releases all resources associated or held by an HTTP stream. Any unread
* header or data is discarded.
+ *
+ * @param s HTTP stream to close
+ * @param abort whether to close the connection and prevent re-use
*/
static inline void vlc_http_stream_close(struct vlc_http_stream *s, bool abort)
{
=====================================
modules/access/http/outfile.h
=====================================
@@ -33,6 +33,7 @@ struct vlc_http_outfile;
/**
* Creates an HTTP output file.
*
+ * @param mgr HTTP connection manager
* @param url URL of the file to write
* @param ua user-agent string (NULL to ignore)
* @param user username for authentication (NULL to skip)
=====================================
modules/access/rtp/xiph.c
=====================================
@@ -1,5 +1,5 @@
/**
- * @file rtpxiph.c
+ * @file xiph.c
* @brief Real-Time Protocol (RTP) Xiph payloads receival
*/
/*****************************************************************************
=====================================
src/input/mrl_helpers.h
=====================================
@@ -34,7 +34,7 @@
* \ingroup mrl
*
* Helper functions related to parsing, as well as generating, data
- * related to the \link MRL-specification\endlink.
+ * related to the \link mrl MRL-specification\endlink.
*
* @{
* \file
=====================================
src/input/stream.h
=====================================
@@ -91,6 +91,11 @@ stream_t *stream_FilterAutoNew( stream_t *source ) VLC_USED;
*/
stream_t *stream_FilterChainNew( stream_t *source, const char *list ) VLC_USED;
+/**
+ * \addtogroup stream_extractor_Internals
+ * @{
+ */
+
/**
* Attach \ref stream_extractor%s according to specified data
*
@@ -110,14 +115,19 @@ stream_t *stream_FilterChainNew( stream_t *source, const char *list ) VLC_USED;
* stream-extractors referred to by `psz_data`, something which is not
* guaranteed.
*
- * \param[out] source a pointer-to-pointer to stream where the attached
+ * \param[out] stream a pointer-to-pointer to stream where the attached
* stream-extractor will be applied. `*stream` will refer
* to the last successful attachment.
+ * \param data the fragment data string to parse.
* \param[out] out_extra `*out_extra` will point to any additional data
* in `psz_data` that does not specify an entity (if any).
* \return VLC_SUCCESS on success, an error-code on failure
**/
-int stream_extractor_AttachParsed( stream_t** stream, const char* psz_data,
+int stream_extractor_AttachParsed( stream_t** stream, const char* data,
char const** out_extra );
+/**
+ * @}
+ */
+
#endif
=====================================
src/input/stream_extractor.c
=====================================
@@ -81,8 +81,8 @@ struct stream_extractor_private {
/**
* Create an MRL for a specific sub-entry
*
- * This internal function is used to create an MRL that refers to \subentry
- * within \ref base, see \ref mrl_helpers for further information.
+ * This internal function is used to create an MRL that refers to \p subentry
+ * within \p base, see \ref mrl_helpers for further information.
**/
static char*
View it on GitLab: https://code.videolan.org/videolan/vlc/-/compare/a32031dc0f5f32083fc54a21397bce732742ccbe...c8d2923ee988ea99bef414de91a57f7b71452ef7
--
View it on GitLab: https://code.videolan.org/videolan/vlc/-/compare/a32031dc0f5f32083fc54a21397bce732742ccbe...c8d2923ee988ea99bef414de91a57f7b71452ef7
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