[vlc-commits] [Git][videolan/vlc][master] 29 commits: libvlc.h: fix doxygen comments
Jean-Baptiste Kempf (@jbk)
gitlab at videolan.org
Mon Aug 9 10:57:56 UTC 2021
Jean-Baptiste Kempf pushed to branch master at VideoLAN / VLC
Commits:
20f0d5af by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
libvlc.h: fix doxygen comments
- - - - -
0b3ea6fc by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
libvlc_events: add LIBVLC_DEPRECATED where deprecated
- - - - -
bea5a709 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
libvlc_media: remove : suffix for doc parameters
Doxygen and other clients will complain.
- - - - -
e0916c46 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
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.
- - - - -
9486ec04 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
libvlc_media_track.h: fix missing parameter name
If the parameter is documented in the prototype, it should be specified
in the prototype and should not be left out.
- - - - -
63d4467b by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_aout.h: update doxygen parameters
The callbacks and opaque seem to have been replaced by a whole owner
object.
- - - - -
25202ba7 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_block: fix missing documented parameters
- - - - -
d14708f0 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_es: fix doxygen parameter name
- - - - -
7b4dc783 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_input_item: fix missing doxygen parameter name
- - - - -
0b1a4591 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_message: fix incorrect doxygen parameter name
- - - - -
f43e9741 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_objects: fix missing documented parameters name
- - - - -
c57e4968 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_picture: fix inexistant doxygen parameter name
- - - - -
0d4a14c0 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_player: fix doxygen comments
- missing documented parameter names.
- void functions with a \return parameter is incorrect.
- non-matching parameter names and documented parameters.
- player_rate doesn't exist in vlc_player_timer_point_Interpolate.
- - - - -
63743f60 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_playlist: fix doxygen comments
- functions returning void with a \return is incorrect.
- missing documented parameter names in the prototypes.
- copy-paste leftover for vlc_playlist_SetPlaybackOrder.
- vlc_playlist_Preparse doesn't need a libvlc instance.
- - - - -
da164a25 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_queue: fix doxygen comments
- documented parameters need to appear in the prototype.
- offset was probably a leftover from copy-paste.
- - - - -
5739f8a0 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_threads: fix missing doxygen documented parameter name
- - - - -
0ec2ef06 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_variables: fix doxygen comments
- - - - -
70f2332b by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_vout_osd: fix doxygen comments
- - - - -
3f585b2f by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_es: fix doxygen trailing comment syntax
- - - - -
5ccc34c4 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_aout: fix doxygen grouping
- - - - -
6712ef6f by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_dialog: fix doxygen comments
- - - - -
6b3e5183 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_fs: fix doxygen comments
- - - - -
5ad2edef by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_interface: fix doxygen comments
- - - - -
b498ce16 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_interrupt: fix doxygen comments
- - - - -
f8852ce8 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_keystore: fix doxygen comments
- - - - -
6eda3852 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_picture: fix doxygen grouping
- - - - -
dd8f3ceb by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
vlc_renderer_discovery: fix doxygen grouping
- - - - -
1c520869 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
mrl_helpers: fix doxygen comment
- - - - -
30d673b2 by Alexandre Janniaux at 2021-08-09T10:14:18+00:00
mrl_helpers: remove typo superfluous semicolon
- - - - -
25 changed files:
- include/vlc/libvlc.h
- include/vlc/libvlc_events.h
- include/vlc/libvlc_media.h
- include/vlc/libvlc_media_player.h
- include/vlc/libvlc_media_track.h
- include/vlc_aout.h
- include/vlc_block.h
- include/vlc_dialog.h
- include/vlc_es.h
- include/vlc_fs.h
- include/vlc_input_item.h
- include/vlc_interface.h
- include/vlc_interrupt.h
- include/vlc_keystore.h
- include/vlc_messages.h
- include/vlc_objects.h
- include/vlc_picture.h
- include/vlc_player.h
- include/vlc_playlist.h
- include/vlc_queue.h
- include/vlc_renderer_discovery.h
- include/vlc_threads.h
- include/vlc_variables.h
- include/vlc_vout_osd.h
- src/input/mrl_helpers.h
Changes:
=====================================
include/vlc/libvlc.h
=====================================
@@ -111,7 +111,7 @@ LIBVLC_API const char *libvlc_vprinterr (const char *fmt, va_list ap);
* Sets the LibVLC error status and message for the current thread.
* Any previous error is overridden.
* \param fmt the format string
- * \param args the arguments
+ * \param ... the arguments for the format string
* \return a nul terminated string in any case
*/
LIBVLC_API const char *libvlc_printerr (const char *fmt, ...);
@@ -409,7 +409,7 @@ LIBVLC_API void libvlc_log_get_context(const libvlc_log_t *ctx,
* \param ctx message context (as passed to the @ref libvlc_log_cb callback)
* \param name object name storage (or NULL) [OUT]
* \param header object header (or NULL) [OUT]
- * \param line source code file line number storage (or NULL) [OUT]
+ * \param id temporarily-unique object identifier (or 0) [OUT]
* \warning The returned module name and source code file name, if non-NULL,
* are only valid until the logging callback returns.
*
=====================================
include/vlc/libvlc_events.h
=====================================
@@ -185,22 +185,22 @@ enum libvlc_event_e {
* \deprecated No longer used.
* This belonged to the removed libvlc_media_list_view_t
*/
- libvlc_MediaListViewItemAdded=0x300,
+ libvlc_MediaListViewItemAdded LIBVLC_DEPRECATED =0x300,
/**
* \deprecated No longer used.
* This belonged to the removed libvlc_media_list_view_t
*/
- libvlc_MediaListViewWillAddItem,
+ libvlc_MediaListViewWillAddItem LIBVLC_DEPRECATED,
/**
* \deprecated No longer used.
* This belonged to the removed libvlc_media_list_view_t
*/
- libvlc_MediaListViewItemDeleted,
+ libvlc_MediaListViewItemDeleted LIBVLC_DEPRECATED,
/**
* \deprecated No longer used.
* This belonged to the removed libvlc_media_list_view_t
*/
- libvlc_MediaListViewWillDeleteItem,
+ libvlc_MediaListViewWillDeleteItem LIBVLC_DEPRECATED,
/**
* Playback of a \link #libvlc_media_list_player_t media list
=====================================
include/vlc/libvlc_media.h
=====================================
@@ -511,8 +511,8 @@ LIBVLC_API libvlc_state_t libvlc_media_get_state(
/**
* Get the current statistics about the media
- * \param p_md: media descriptor object
- * \param p_stats: structure that contain the statistics about the media
+ * \param p_md media descriptor object
+ * \param p_stats structure that contain the statistics about the media
* (this structure must be allocated by the caller)
* \retval true statistics are available
* \retval false otherwise
=====================================
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,
=====================================
include/vlc/libvlc_media_track.h
=====================================
@@ -215,7 +215,7 @@ libvlc_media_tracklist_delete( libvlc_media_tracklist_t *list );
* \return the same track, need to be released with libvlc_media_track_release()
*/
LIBVLC_API libvlc_media_track_t *
-libvlc_media_track_hold( libvlc_media_track_t * );
+libvlc_media_track_hold( libvlc_media_track_t *track );
/**
* Release a single track
=====================================
include/vlc_aout.h
=====================================
@@ -547,6 +547,7 @@ static inline int aout_TimeGet(audio_output_t *aout, vlc_tick_t *delay)
/**
* @defgroup audio_output__meter Audio meter API
+ * @{
*/
/**
@@ -661,9 +662,8 @@ vlc_audio_meter_Reset(struct vlc_audio_meter *meter, const audio_sample_format_t
* @param meter audio meter structure
* @param chain name of the module, can contain specific module options using
* the following chain convention:"name{option1=a,option2=b}"
- * @param cbs pointer to a vlc_audio_meter_events structure, the
+ * @param owner pointer to a vlc_audio_meter_plugin_owner structure, the
* structure must stay valid during the lifetime of the plugin
- * @param cbs_data opaque pointer used by the callbacks
* @return a valid audio meter plugin, or NULL in case of error
*/
VLC_API vlc_audio_meter_plugin *
=====================================
include/vlc_block.h
=====================================
@@ -245,7 +245,7 @@ static inline block_t *block_Duplicate( const block_t *p_block )
* @return NULL in case of error (ptr free()'d in that case), or a valid
* block_t pointer.
*/
-VLC_API block_t *block_heap_Alloc(void *, size_t) VLC_USED VLC_MALLOC;
+VLC_API block_t *block_heap_Alloc(void *addr, size_t length) VLC_USED VLC_MALLOC;
/**
* Wraps a memory mapping in a block
@@ -565,7 +565,7 @@ static inline void vlc_fifo_WaitCond(vlc_fifo_t *fifo, vlc_cond_t *condvar)
* @warning The FIFO must be locked by the calling thread using
* vlc_fifo_Lock(). Otherwise behaviour is undefined.
*/
-VLC_API void vlc_fifo_QueueUnlocked(vlc_fifo_t *fifo, block_t *);
+VLC_API void vlc_fifo_QueueUnlocked(vlc_fifo_t *fifo, block_t *block);
/**
* Dequeues the first block from a locked FIFO, if any.
=====================================
include/vlc_dialog.h
=====================================
@@ -478,6 +478,7 @@ vlc_dialog_provider_set_ext_callback(vlc_object_t *p_obj,
#define vlc_dialog_provider_set_ext_callback(a, b, c) \
vlc_dialog_provider_set_ext_callback(VLC_OBJECT(a), b, c)
-/** @} @} */
+/** @} */
+/** @} */
#endif
=====================================
include/vlc_es.h
=====================================
@@ -289,7 +289,7 @@ typedef enum video_transfer_func_t
{
TRANSFER_FUNC_UNDEF,
TRANSFER_FUNC_LINEAR,
- TRANSFER_FUNC_SRGB /*< Gamma 2.2 */,
+ TRANSFER_FUNC_SRGB /**< Gamma 2.2 */,
TRANSFER_FUNC_BT470_BG,
TRANSFER_FUNC_BT470_M,
TRANSFER_FUNC_BT709,
@@ -326,8 +326,8 @@ typedef enum video_color_space_t
typedef enum video_chroma_location_t
{
CHROMA_LOCATION_UNDEF,
- CHROMA_LOCATION_LEFT, /*< Most common in MPEG-2 Video, H.264/265 */
- CHROMA_LOCATION_CENTER, /*< Most common in MPEG-1 Video, JPEG */
+ CHROMA_LOCATION_LEFT, /**< Most common in MPEG-2 Video, H.264/265 */
+ CHROMA_LOCATION_CENTER, /**< Most common in MPEG-1 Video, JPEG */
CHROMA_LOCATION_TOP_LEFT,
CHROMA_LOCATION_TOP_CENTER,
CHROMA_LOCATION_BOTTOM_LEFT,
@@ -641,7 +641,7 @@ struct es_format_t
union {
struct {
audio_format_t audio; /**< description of audio format */
- audio_replay_gain_t audio_replay_gain; /*< audio replay gain information */
+ audio_replay_gain_t audio_replay_gain; /**< audio replay gain information */
};
video_format_t video; /**< description of video format */
subs_format_t subs; /**< description of subtitle format */
@@ -707,7 +707,7 @@ static inline void es_format_Change( es_format_t *fmt, int i_cat, vlc_fourcc_t i
*
* Any held ES tracks must be released with vlc_es_id_Release().
*
- * @param id pointer to the ES id
+ * @param es pointer to the ES id
* @return the same ES pointer, for convenience
*/
VLC_API vlc_es_id_t *
=====================================
include/vlc_fs.h
=====================================
@@ -312,4 +312,5 @@ static inline void vlc_rewinddir( DIR *dir )
# define lseek lseek64
#endif
+/** @} */
#endif
=====================================
include/vlc_input_item.h
=====================================
@@ -446,7 +446,7 @@ input_item_Parse(input_item_t *item, vlc_object_t *parent,
* afterward.
* @note Calling this function will cause the on_ended callback to be invoked.
*
- * @param the parser to interrupt
+ * @param parser the parser to interrupt
*/
VLC_API void
input_item_parser_id_Interrupt(input_item_parser_id_t *parser);
=====================================
include/vlc_interface.h
=====================================
@@ -107,7 +107,7 @@ vlc_intf_GetMainPlaylist(intf_thread_t *intf);
VLC_API void vlc_LogSet(libvlc_int_t *, const struct vlc_logger_operations *,
void *data);
-/*@}*/
+/** @} */
/* Interface dialog ids for dialog providers */
typedef enum vlc_intf_dialog {
=====================================
include/vlc_interrupt.h
=====================================
@@ -232,5 +232,6 @@ VLC_API void vlc_interrupt_forward_start(vlc_interrupt_t *to,
*/
VLC_API int vlc_interrupt_forward_stop(void *const data[2]);
-/** @} @} */
+/** @} */
+/** @} */
#endif
=====================================
include/vlc_keystore.h
=====================================
@@ -313,6 +313,7 @@ struct vlc_keystore
const char *const ppsz_values[KEY_MAX]);
};
-/** @} @} */
+/** @} */
+/** @} */
#endif
=====================================
include/vlc_messages.h
=====================================
@@ -76,7 +76,7 @@ typedef struct vlc_log_t
* \param func calling function name (normally __func__) or NULL
* \param format printf-like message format
*/
-VLC_API void vlc_object_Log(vlc_object_t *obj, int prio, const char *module,
+VLC_API void vlc_object_Log(vlc_object_t *obj, int type, const char *module,
const char *file, unsigned line, const char *func,
const char *format, ...) VLC_FORMAT(7, 8);
=====================================
include/vlc_objects.h
=====================================
@@ -121,7 +121,7 @@ struct libvlc_int_t
*
* @return the new object, or NULL on error.
*/
-VLC_API void *vlc_object_create( vlc_object_t *, size_t ) VLC_MALLOC VLC_USED;
+VLC_API void *vlc_object_create( vlc_object_t *, size_t i_size) VLC_MALLOC VLC_USED;
/**
* Drops the strong reference to an object.
=====================================
include/vlc_picture.h
=====================================
@@ -29,6 +29,9 @@
#include <vlc_atomic.h>
/**
+ * \defgroup picture Generic picture API
+ * \ingroup output
+ * @{
* \file
* This file defines picture structures and functions in vlc
*/
@@ -242,10 +245,7 @@ static inline picture_t * vlc_picture_chain_PeekFront(vlc_picture_chain_t *chain
* Append a picture to a picture chain.
*
* \param chain the picture chain pointer
- * \param tail the known tail of the picture chain
* \param pic the picture to append to the chain
- *
- * \return the new tail of the picture chain
*/
static inline void vlc_picture_chain_Append(vlc_picture_chain_t *chain,
picture_t *pic)
@@ -483,6 +483,6 @@ static inline void picture_SwapUV(picture_t *picture)
picture->p[V_PLANE] = tmp_plane;
}
-/**@}*/
+/** @} */
#endif /* VLC_PICTURE_H */
=====================================
include/vlc_player.h
=====================================
@@ -836,7 +836,6 @@ vlc_player_Navigate(vlc_player_t *player, enum vlc_player_nav nav);
* @param player locked player instance
* @param viewpoint the viewpoint value
* @param whence absolute or relative
- * @return VLC_SUCCESS or a VLC error code
*/
VLC_API void
vlc_player_UpdateViewpoint(vlc_player_t *player,
@@ -1456,7 +1455,7 @@ vlc_player_GetSubtitleTrackAt(vlc_player_t *player, size_t index)
* The referenced structure can be safely copied with vlc_player_track_Dup().
*
* @param player locked player instance
- * @param id an ES ID (retrieved from vlc_player_cbs.on_track_list_changed or
+ * @param es_id an ES ID (retrieved from vlc_player_cbs.on_track_list_changed or
* vlc_player_GetTrackAt())
* @return a valid player track or NULL (if the track was terminated by the
* playback thread)
@@ -1474,7 +1473,7 @@ vlc_player_GetTrack(vlc_player_t *player, vlc_es_id_t *es_id);
* unlocked.
*
* @param player locked player instance
- * @param id an ES ID (retrieved from vlc_player_cbs.on_track_list_changed or
+ * @param es_id an ES ID (retrieved from vlc_player_cbs.on_track_list_changed or
* vlc_player_GetTrackAt())
* @param order if not null, the order of the vout
* @return a valid vout or NULL (if the track is disabled, it it's not a video
@@ -1559,7 +1558,7 @@ vlc_player_SelectTracksByStringIds(vlc_player_t *player,
* vlc_player_cbs.on_track_selection_changed event.
*
* @param player locked player instance
- * @param id an ES ID (retrieved from vlc_player_cbs.on_track_list_changed or
+ * @param es_id an ES ID (retrieved from vlc_player_cbs.on_track_list_changed or
* vlc_player_GetTrackAt())
* @param policy exclusive or simultaneous
* @return the number of track selected for es_id category
@@ -1650,7 +1649,7 @@ vlc_player_SelectPrevTrack(vlc_player_t *player,
* vlc_player_cbs.on_track_selection_changed event.
*
* @param player locked player instance
- * @param id an ES ID (retrieved from vlc_player_cbs.on_track_list_changed or
+ * @param es_id an ES ID (retrieved from vlc_player_cbs.on_track_list_changed or
* vlc_player_GetTrackAt())
*/
VLC_API void
@@ -1691,7 +1690,7 @@ vlc_player_UnselectTrackCategory(vlc_player_t *player,
* vlc_player_cbs.on_track_selection_changed event.
*
* @param player locked player instance
- * @param id an ES ID (retrieved from vlc_player_cbs.on_track_list_changed or
+ * @param es_id an ES ID (retrieved from vlc_player_cbs.on_track_list_changed or
* vlc_player_GetTrackAt())
*/
VLC_API void
@@ -1927,7 +1926,7 @@ vlc_player_SetCategoryDelay(vlc_player_t *player, enum es_format_category_e cat,
* @see vlc_player_cbs.on_track_delay_changed
*
* @param player locked player instance
- * @param id an ES ID (retrieved from vlc_player_cbs.on_track_list_changed or
+ * @param es_id an ES ID (retrieved from vlc_player_cbs.on_track_list_changed or
* vlc_player_GetTrackAt())
* @return a valid delay or INT64_MAX is no delay is set for this track
*/
@@ -1944,7 +1943,7 @@ vlc_player_GetEsIdDelay(vlc_player_t *player, vlc_es_id_t *es_id);
* future changes of delay made by vlc_player_SetCategoryDelay()
*
* @param player locked player instance
- * @param id an ES ID (retrieved from vlc_player_cbs.on_track_list_changed or
+ * @param es_id an ES ID (retrieved from vlc_player_cbs.on_track_list_changed or
* vlc_player_GetTrackAt())
* @param delay a valid time or INT64_MAX to use default category delay
* @param whence absolute or relative
@@ -3368,7 +3367,8 @@ struct vlc_player_timer_smpte_cbs
*/
VLC_API vlc_player_timer_id *
vlc_player_AddTimer(vlc_player_t *player, vlc_tick_t min_period,
- const struct vlc_player_timer_cbs *cbs, void *data);
+ const struct vlc_player_timer_cbs *cbs,
+ void *cbs_data);
/**
* Add a smpte timer in order to get accurate video frame updates
@@ -3383,7 +3383,7 @@ vlc_player_AddTimer(vlc_player_t *player, vlc_tick_t min_period,
VLC_API vlc_player_timer_id *
vlc_player_AddSmpteTimer(vlc_player_t *player,
const struct vlc_player_timer_smpte_cbs *cbs,
- void *data);
+ void *cbs_data);
/**
* Remove a player timer
@@ -3400,7 +3400,6 @@ vlc_player_RemoveTimer(vlc_player_t *player, vlc_player_timer_id *timer);
* @param point time update obtained via the vlc_player_timer_cbs.on_update()
* callback
* @param system_now current system date
- * @param player_rate rate of the player
* @param out_ts pointer where to set the interpolated ts, subtract this time
* with VLC_TICK_0 to get the original value.
* @param out_pos pointer where to set the interpolated position
=====================================
include/vlc_playlist.h
=====================================
@@ -396,7 +396,8 @@ vlc_playlist_AddListener(vlc_playlist_t *playlist,
* vlc_playlist_AddListener()
*/
VLC_API void
-vlc_playlist_RemoveListener(vlc_playlist_t *, vlc_playlist_listener_id *);
+vlc_playlist_RemoveListener(vlc_playlist_t *playlist,
+ vlc_playlist_listener_id *id);
/**
* Return the number of items.
@@ -687,7 +688,7 @@ vlc_playlist_GetPlaybackRepeat(vlc_playlist_t *playlist);
* \return the playback order
*/
VLC_API enum vlc_playlist_playback_order
-vlc_playlist_GetPlaybackOrder(vlc_playlist_t *);
+vlc_playlist_GetPlaybackOrder(vlc_playlist_t *playlist);
/**
* Change the playback "repeat" mode.
@@ -703,7 +704,7 @@ vlc_playlist_SetPlaybackRepeat(vlc_playlist_t *playlist,
* Change the playback order
*
* \param playlist the playlist, locked
- * \param repeat the new playback order
+ * \param order the new playback order
*/
VLC_API void
vlc_playlist_SetPlaybackOrder(vlc_playlist_t *playlist,
@@ -818,7 +819,6 @@ vlc_playlist_Start(vlc_playlist_t *playlist);
* Stop the player.
*
* \param playlist the playlist, locked
- * \return VLC_SUCCESS on success, another value on error
*/
VLC_API void
vlc_playlist_Stop(vlc_playlist_t *playlist);
@@ -827,7 +827,6 @@ vlc_playlist_Stop(vlc_playlist_t *playlist);
* Pause the player.
*
* \param playlist the playlist, locked
- * \return VLC_SUCCESS on success, another value on error
*/
VLC_API void
vlc_playlist_Pause(vlc_playlist_t *playlist);
@@ -836,7 +835,6 @@ vlc_playlist_Pause(vlc_playlist_t *playlist);
* Resume the player.
*
* \param playlist the playlist, locked
- * \return VLC_SUCCESS on success, another value on error
*/
VLC_API void
vlc_playlist_Resume(vlc_playlist_t *playlist);
@@ -861,7 +859,6 @@ vlc_playlist_PlayAt(vlc_playlist_t *playlist, size_t index)
* Preparse a media, and expand it in the playlist on subitems added.
*
* \param playlist the playlist (not necessarily locked)
- * \param libvlc the libvlc instance
* \param media the media to preparse
*/
VLC_API void
=====================================
include/vlc_queue.h
=====================================
@@ -196,11 +196,11 @@ VLC_API void vlc_queue_Enqueue(vlc_queue_t *, void *entry);
* This function dequeues an entry from a thread-safe queue. If the queue is
* empty, it will wait until at least one entry is available.
*
- * @param offset offset of the next pointer within a queue entry
+ * @param queue queue object to dequeue an entry from
*
* @return the first entry in the queue, or NULL if the queue is empty
*/
-VLC_API void *vlc_queue_Dequeue(vlc_queue_t *) VLC_USED;
+VLC_API void *vlc_queue_Dequeue(vlc_queue_t *queue) VLC_USED;
/**
* Dequeues all entries.
=====================================
include/vlc_renderer_discovery.h
=====================================
@@ -214,6 +214,7 @@ static int vlc_rd_probe_open(vlc_object_t *obj) \
set_capability("renderer probe", 100) \
set_callback(vlc_rd_probe_open)
-/** @} @} */
+/** @} */
+/** @} */
#endif
=====================================
include/vlc_threads.h
=====================================
@@ -977,7 +977,7 @@ static inline void vlc_timer_schedule_asap(vlc_timer_t timer, vlc_tick_t interva
* \param timer initialized timer
* \return the timer overrun counter (typically zero)
*/
-VLC_API unsigned vlc_timer_getoverrun(vlc_timer_t) VLC_USED;
+VLC_API unsigned vlc_timer_getoverrun(vlc_timer_t timer) VLC_USED;
/** @} */
=====================================
include/vlc_variables.h
=====================================
@@ -760,11 +760,11 @@ VLC_API int var_InheritURational(vlc_object_t *obj, unsigned *num,
*
* @param obj VLC object on which to set variables (and emit error messages)
* @param mrl string to parse
- * @param pref prefix to prepend to option names in the string
+ * @param prefix prefix to prepend to option names in the string
*
* @return VLC_ENOMEM on error, VLC_SUCCESS on success.
*/
-VLC_API int var_LocationParse(vlc_object_t *, const char *mrl, const char *prefix);
+VLC_API int var_LocationParse(vlc_object_t *obj, const char *mrl, const char *prefix);
#ifndef DOC
#define var_Create(a,b,c) var_Create(VLC_OBJECT(a), b, c)
=====================================
include/vlc_vout_osd.h
=====================================
@@ -65,8 +65,9 @@ VLC_API int vout_OSDEpg( vout_thread_t *, input_item_t * );
VLC_API void vout_OSDText( vout_thread_t *vout, int channel, int position, vlc_tick_t duration, const char *text );
/**
- * \brief Write an informative message at the default location,
- * for the default duration and only if the OSD option is enabled.
+ * Write an informative message at the default location, for the default duration and only
+ * if the OSD option is enabled.
+ *
* \param vout The vout on which the message will be displayed
* \param channel Subpicture channel
* \param format printf style formatting
@@ -74,7 +75,7 @@ VLC_API void vout_OSDText( vout_thread_t *vout, int channel, int position, vlc_t
*
* Provided for convenience.
*/
-VLC_API void vout_OSDMessageVa(vout_thread_t *, int, const char *, va_list);
+VLC_API void vout_OSDMessageVa(vout_thread_t *vout, int channel, const char *format, va_list args);
static inline void
vout_OSDMessage(vout_thread_t *vout, int channel, const char *format, ...)
@@ -89,10 +90,11 @@ vout_OSDMessage(vout_thread_t *vout, int channel, const char *format, ...)
* Display a slider on the video output.
* \param p_this The object that called the function.
* \param i_channel Subpicture channel
- * \param i_postion Current position in the slider
+ * \param i_position Current position in the slider
* \param i_type Types are: OSD_HOR_SLIDER and OSD_VERT_SLIDER.
*/
-VLC_API void vout_OSDSlider( vout_thread_t *, int, int , short );
+VLC_API void vout_OSDSlider( vout_thread_t *p_this, int i_channel,
+ int i_position, short i_type);
/**
* Display an Icon on the video output.
@@ -100,7 +102,8 @@ VLC_API void vout_OSDSlider( vout_thread_t *, int, int , short );
* \param i_channel Subpicture channel
* \param i_type Types are: OSD_PLAY_ICON, OSD_PAUSE_ICON, OSD_SPEAKER_ICON, OSD_MUTE_ICON
*/
-VLC_API void vout_OSDIcon( vout_thread_t *, int, short );
+VLC_API void vout_OSDIcon( vout_thread_t *p_this, int i_channel,
+ short i_type);
/** @} */
#ifdef __cplusplus
=====================================
src/input/mrl_helpers.h
=====================================
@@ -156,11 +156,9 @@ error:
for( size_t i = 0; i < vlc_array_count( out_items ); ++i )
free( vlc_array_item_at_index( out_items, i ) );
vlc_array_clear( out_items );
- return VLC_EGENERIC;;
+ return VLC_EGENERIC;
}
-/*
- * @}
- **/
+/** @} */
#endif /* include-guard */
View it on GitLab: https://code.videolan.org/videolan/vlc/-/compare/89b561eaa213582fff9625541edb5d7dbb299fb6...30d673b2cf2c27724b7f96bb780083bf9ee44e3a
--
View it on GitLab: https://code.videolan.org/videolan/vlc/-/compare/89b561eaa213582fff9625541edb5d7dbb299fb6...30d673b2cf2c27724b7f96bb780083bf9ee44e3a
You're receiving this email because of your account on code.videolan.org.
More information about the vlc-commits
mailing list