[vlc-commits] [Git][videolan/vlc][master] 49 commits: doc: standalone: fix reference to libvlc

Steve Lhomme (@robUx4) gitlab at videolan.org
Thu Aug 3 09:15:23 UTC 2023



Steve Lhomme pushed to branch master at VideoLAN / VLC


Commits:
6b2df09c by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
doc: standalone: fix reference to libvlc

- - - - -
7165cacf by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
doc: mrl: fix doxygen unresolved references

Fix doxygen warnings:

    doc/standalone/mrl.dox:9: warning: unable to resolve reference to
    'input_CreatePreparser' for \ref command

- - - - -
2e577b4d by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_cxx_helpers.hpp: fix documentation parameter name

- - - - -
d1bb1455 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_cxx_helpers.hpp: enable file with -DDOC

- - - - -
0d2b9b15 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_ancillary: fix doxygen grouping

    include/vlc_ancillary.h:222: warning: end of file while inside a group

- - - - -
eb43e3e3 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_aout: move documentation from source file

- - - - -
5b34f2e5 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_aout: fix doxygen warnings

    include/vlc_aout.h:438: warning: argument 'ptr' of command @param is not found in the argument list of aout_ChannelReorder(void *, size_t, uint8_t, const uint8_t *, vlc_fourcc_t)

    include/vlc_aout.h:438: warning: argument 'bytes' of command @param is not found in the argument list of aout_ChannelReorder(void *, size_t, uint8_t, const uint8_t *, vlc_fourcc_t)

    include/vlc_aout.h:438: warning: argument 'channels' of command @param is not found in the argument list of aout_ChannelReorder(void *, size_t, uint8_t, const uint8_t *, vlc_fourcc_t)

    include/vlc_aout.h:438: warning: argument 'chans_table' of command @param is not found in the argument list of aout_ChannelReorder(void *, size_t, uint8_t, const uint8_t *, vlc_fourcc_t)

    include/vlc_aout.h:438: warning: argument 'fourcc' of command @param is not found in the argument list of aout_ChannelReorder(void *, size_t, uint8_t, const uint8_t *, vlc_fourcc_t)

    src/audio_output/output.c:912: warning: The following parameter of aout_DeviceSet(audio_output_t *aout, const char *id) is not documented:
      parameter 'aout'

    include/vlc_aout.h:554: warning: argument 'id' of command @param is not found in the argument list of aout_DeviceSet(audio_output_t *aout, const char *d)

    include/vlc_aout.h:554: warning: The following parameter of aout_DeviceSet(audio_output_t *aout, const char *d) is not documented:
      parameter 'd'

    src/audio_output/output.c:929: warning: The following parameter of aout_DevicesList(audio_output_t *aout, char ***ids, char ***names) is not documented:
      parameter 'aout'

    src/audio_output/output.c:851: warning: The following parameter of aout_VolumeUpdate(audio_output_t *aout, int value, float *volp) is not documented:
      parameter 'aout'

    include/vlc_aout.h:378: warning: The following parameter of aout_GainRequest(audio_output_t *aout, float gain) is not documented:
      parameter 'aout'

    include/vlc_aout.h:367: warning: The following parameter of aout_HotplugReport(audio_output_t *aout, const char *id, const char *name) is not documented:
      parameter 'aout'

    include/vlc_aout.h:350: warning: The following parameter of aout_PolicyReport(audio_output_t *aout, bool cork) is not documented:
      parameter 'aout'

- - - - -
d8bc61d9 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_block: fix doxygen unnamed group

Fix doxygen warnings:

    include/vlc_block.h:30: warning: missing title after \defgroup block

- - - - -
f3f38936 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_diffutil: split operation from union

Splitting the different operations into different structures improve the
documentation and allow a user to create the given structure with
designated initializer, while preparing for potential C++ helpers using
function overload on the type.

- - - - -
adf8d6d6 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_diffutil: fix doxygen examples

Examples in doxygen are either added via @example <example_file>, or via
a @snipper <example file> <snippet name> command, or via a block between
@code and @endcode. The diffutil documentation was mixing the first and
last ones.

- - - - -
81bc6115 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_charset.h: fix doxygen warnings

    include/vlc_charset.h:422: warning: argument 'p' of command @param is not found in the argument list of vlc_asprintf_c(char **, const char *,...)

    include/vlc_charset.h:422: warning: argument 'fmt' of command @param is not found in the argument list of vlc_asprintf_c(char **, const char *,...)

- - - - -
f4a4abaf by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_decoder: move some documentation and fix doxygen warnings

    src/input/decoder.c:2232: warning: argument 'p_dec' of command @param is not found in the argument list of vlc_input_decoder_Decode(vlc_input_decoder_t *p_owner, vlc_frame_t *frame, bool b_do_pace)

    src/input/decoder.c:2232: warning: The following parameters of vlc_input_decoder_Decode(vlc_input_decoder_t *p_owner, vlc_frame_t *frame, bool b_do_pace) are not documented:
      parameter 'p_owner'
      parameter 'b_do_pace'

    include/vlc_decoder.h:49: warning: argument 'decoder' of command @param is not found in the argument list of vlc_input_decoder_Delete(vlc_input_decoder_t *p_owner)

    include/vlc_decoder.h:49: warning: argument 'p_input' of command @param is not found in the argument list of vlc_input_decoder_Delete(vlc_input_decoder_t *p_owner)

    include/vlc_decoder.h:49: warning: argument 'p_es' of command @param is not found in the argument list of vlc_input_decoder_Delete(vlc_input_decoder_t *p_owner)

    include/vlc_decoder.h:49: warning: The following parameter of vlc_input_decoder_Delete(vlc_input_decoder_t *p_owner) is not documented:
      parameter 'p_owner'

    include/vlc_decoder.h:49: warning: found documented return type for vlc_input_decoder_Delete that does not return anything

- - - - -
bd30c25a by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_demux: fix doxygen warnings

    include/vlc_demux.h:659: warning: The following parameter of vlc_demux_chained_ControlVa(vlc_demux_chained_t *dc, int query, va_list args) is not documented:
      parameter 'dc'

    include/vlc_demux.h:650: warning: The following parameter of vlc_demux_chained_Send(vlc_demux_chained_t *dc, block_t *block) is not documented:
      parameter 'dc'

- - - - -
78d94814 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_dialog: fix doxygen warnings

    include/vlc_dialog.h:383: warning: The following parameter of vlc_dialog_provider_set_callbacks(vlc_object_t *p_obj, const vlc_dialog_cbs *p_cbs, void *p_data) is not documented:
      parameter 'p_obj'

    include/vlc_dialog.h:395: warning: The following parameter of vlc_dialog_provider_set_error_callback(vlc_object_t *p_obj, vlc_dialog_error_cbs p_cbs, void *p_data) is not documented:
      parameter 'p_obj'

    include/vlc_dialog.h:482: warning: The following parameter of vlc_dialog_provider_set_ext_callback(vlc_object_t *p_obj, vlc_dialog_ext_update_cb pf_update, void *p_data) is not documented:
      parameter 'p_obj'

- - - - -
1260ff24 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_filter: move documentation and fix doxygen warnings

    include/vlc_filter.h:371: warning: The following parameters of filter_AddProxyCallbacks(vlc_object_t *obj, filter_t *filter, vlc_callback_t restart_cb) are not documented:
      parameter 'obj'
      parameter 'filter'

    include/vlc_filter.h:527: warning: The following parameter of filter_chain_AppendFilter(filter_chain_t *chain, const char *name, const config_chain_t *cfg, const es_format_t *fmt_out) is not documented:
      parameter 'cfg'

    include/vlc_filter.h:471: warning: argument 'psz_capability' of command @param is not found in the argument list of filter_chain_NewSPU(vlc_object_t *obj, const char *cap)

    include/vlc_filter.h:471: warning: The following parameter of filter_chain_NewSPU(vlc_object_t *obj, const char *cap) is not documented:
      parameter 'cap'

    include/vlc_filter.h:506: warning: Found unknown command '\paramt'

    include/vlc_filter.h:504: warning: The following parameter of filter_chain_Reset(filter_chain_t *p_chain, const es_format_t *p_fmt_in, vlc_video_context *vctx_in, const es_format_t *p_fmt_out) is not documented:
      parameter 'vctx_in'

    include/vlc_filter.h:608: warning: The following parameter of filter_chain_SubSource(filter_chain_t *chain, spu_t *spu, vlc_tick_t display_date) is not documented:
      parameter 'spu'

    include/vlc_filter.h:383: warning: The following parameters of filter_DelProxyCallbacks(vlc_object_t *obj, filter_t *filter, vlc_callback_t restart_cb) are not documented:
      parameter 'obj'
      parameter 'filter'

- - - - -
abcb51f4 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_frame: fix doxygen warnings

    include/vlc_frame.h:359: warning: The following parameter of vlc_frame_FilePath(const char *path, bool write) is not documented:
      parameter 'path'

    include/vlc_frame.h:250: warning: The following parameter of vlc_frame_GetAncillary(vlc_frame_t *frame, vlc_ancillary_id id) is not documented:
      parameter 'frame'

    include/vlc_frame.h:199: warning: The following parameter of vlc_frame_Realloc(vlc_frame_t *frame, ssize_t pre, size_t body) is not documented:
      parameter 'frame'

    include/vlc_frame.h:696: warning: The following parameter of vlc_fifo_QueueUnlocked(vlc_fifo_t *fifo, vlc_frame_t *block) is not documented:
      parameter 'fifo'

- - - - -
4b51462f by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_fs: fix doxygen warnings

    include/vlc_fs.h:201: warning: The following parameter of vlc_lstat(const char *filename, struct stat *buf) is not documented:
      parameter 'buf'

    include/vlc_fs.h:193: warning: The following parameter of vlc_stat(const char *filename, struct stat *buf) is not documented:
      parameter 'buf'

    include/vlc_fs.h:92: warning: argument 'dir' of command @param is not found in the argument list of vlc_openat(int fd, const char *filename, int flags,...)

    include/vlc_fs.h:92: warning: The following parameter of vlc_openat(int fd, const char *filename, int flags,...) is not documented:
      parameter 'fd'

- - - - -
a496775c by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_http: fix doxygen warnings

    include/vlc_http.h:90: error: argument 'p_jar' of command @param is not found in the argument list of vlc_http_cookies_fetch(vlc_http_cookie_jar_t *jar, bool secure, const char *host, const char *path) (warning treated as error, aborting now)

    include/vlc_http.h:80: error: The following parameters of vlc_http_cookies_store(vlc_http_cookie_jar_t *jar, const char *cookie, const char *host, const char *path) are not documented:
      parameter 'host'
      parameter 'path' (warning treated as error, aborting now)

- - - - -
04bb7ce4 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_input_item: fix doxygen warnings

    include/vlc_input_item.h:588: error: argument 'status' of command @param is not found in the argument list of vlc_readdir_helper_additem(struct vlc_readdir_helper *p_rdh, const char *psz_uri, const char *psz_flatpath, const char *psz_filename, int i_type, int i_net, input_item_t **created_item)

    include/vlc_input_item.h:579: error: The following parameter of vlc_readdir_helper_finish(struct vlc_readdir_helper *p_rdh, bool b_success) is not documented:
      parameter 'p_rdh'

    include/vlc_input_item.h:568: warning: The following parameter of vlc_readdir_helper_init(struct vlc_readdir_helper *p_rdh, vlc_object_t *p_obj, input_item_node_t *p_node) is not documented:
      parameter 'p_obj'

- - - - -
26cdd1d6 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_interrupt: fix doxygen warnings

    include/vlc_interrupt.h:208: warning: The following parameter of vlc_interrupt_forward_start(vlc_interrupt_t *to, void *data[2]) is not documented:
      parameter 'data'

- - - - -
86b643a9 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_keystore: fix doxygen warnings

    include/vlc_keystore.h:121: warning: The following parameter of vlc_keystore_find(vlc_keystore *p_keystore, const char *const ppsz_values[KEY_MAX], vlc_keystore_entry **pp_entries) is not documented:
      parameter 'p_keystore'

    include/vlc_keystore.h:136: warning: The following parameter of vlc_keystore_remove(vlc_keystore *p_keystore, const char *const ppsz_values[KEY_MAX]) is not documented:
      parameter 'p_keystore'

    include/vlc_keystore.h:102: warning: The following parameter of vlc_keystore_store(vlc_keystore *p_keystore, const char *const ppsz_values[KEY_MAX], const uint8_t *p_secret, ssize_t i_secret_len, const char *psz_label) is not documented:
      parameter 'p_keystore'

    include/vlc_keystore.h:219: warning: The following parameter of vlc_credential_get(vlc_credential *p_credential, vlc_object_t *p_parent, const char *psz_option_username, const char *psz_option_password, const char *psz_dialog_title, const char *psz_dialog_fmt,...) is not documented:
      parameter 'p_credential'

    include/vlc_keystore.h:203: warning: argument 'psz_url' of command @param is not found in the argument list of vlc_credential_init(vlc_credential *p_credential, const vlc_url_t *p_url)

    include/vlc_keystore.h:203: warning: The following parameters of vlc_credential_init(vlc_credential *p_credential, const vlc_url_t *p_url) are not documented:
      parameter 'p_credential'
      parameter 'p_url'

- - - - -
1747fb92 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_media_library: fix doxygen warnings

    include/vlc_media_library.h:658: warning: Unsupported xml/html tag <type> found

    include/vlc_media_library.h:918: warning: argument 'p_handle' of command @param is not found in the argument list of vlc_ml_event_unregister_callback(vlc_medialibrary_t *p_ml, vlc_ml_event_callback_t *p_callback)

    include/vlc_media_library.h:918: warning: The following parameters of vlc_ml_event_unregister_callback(vlc_medialibrary_t *p_ml, vlc_ml_event_callback_t *p_callback) are not documented:
      parameter 'p_ml'
      parameter 'p_callback'

    include/vlc_media_library.h:924: warning: The following parameter of vlc_ml_event_unregister_from_callback(vlc_medialibrary_t *p_ml, vlc_ml_event_callback_t *p_callback) is not documented:
      parameter 'p_ml'

    include/vlc_media_library.h:1530: warning: The following parameter of vlc_ml_list_artists(vlc_medialibrary_t *p_ml, const vlc_ml_query_params_t *params, bool b_include_all) is not documented:
      parameter 'p_ml'

- - - - -
0e83340e by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_media_source.h: fix doxygen warning

    include/vlc_media_source.h:220: warning: The following parameter of vlc_media_tree_Find(vlc_media_tree_t *tree, const input_item_t *media, input_item_node_t **result, input_item_node_t **result_parent) is not documented:
      parameter 'media'

- - - - -
42d17ab8 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_media_source.h: remove trailing characters

- - - - -
79d1927b by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_memstream: fix doxygen warnings

    include/vlc_memstream.h:122: warning: argument 'Unsigned' of command @param is not found in the argument list of vlc_memstream_putc(struct vlc_memstream *ms, int c)

    include/vlc_memstream.h:122: warning: The following parameters of vlc_memstream_putc(struct vlc_memstream *ms, int c) are not documented:
      parameter 'ms'
      parameter 'c'

    include/vlc_memstream.h:110: warning: argument 'length' of command @param is not found in the argument list of vlc_memstream_write(struct vlc_memstream *ms, const void *ptr, size_t len)

    include/vlc_memstream.h:110: warning: The following parameters of vlc_memstream_write(struct vlc_memstream *ms, const void *ptr, size_t len) are not documented:
      parameter 'ms'
      parameter 'len'

- - - - -
843b9865 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_memstream: remove trailing characters

- - - - -
4c78b429 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_modules: fix doxygen warnings

    include/vlc_modules.h:77: warning: argument 'capability' of command @param is not found in the argument list of vlc_module_load(struct vlc_logger *log, const char *cap, const char *name, bool strict, vlc_activate_t probe,...)

    include/vlc_modules.h:77: warning: The following parameter of vlc_module_load(struct vlc_logger *log, const char *cap, const char *name, bool strict, vlc_activate_t probe,...) is not documented:
      parameter 'cap'

- - - - -
46ae1432 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_network: move documentation from source file

The documentation for vlc_GetProxyUrl was duplicated in multiple
location and confusing doxygen:

    src/darwin/netconf.m:41: warning: argument 'url' from the argument list of vlc_getProxyUrl has multiple @param documentation sections

- - - - -
8c650b8f by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_network: fix doxygen warnings

    include/vlc_network.h:85: warning: The following parameter of vlc_socketpair(int pf, int type, int proto, int fds[2], bool nonblock) is not documented:
      parameter 'fds'

    src/network/getaddrinfo.c:69: warning: argument 'i_port' of command @param is not found in the argument list of vlc_getaddrinfo(const char *node, unsigned port, const struct addrinfo *hints, struct addrinfo **res)

    src/network/getaddrinfo.c:69: warning: argument 'p_hints' of command @param is not found in the argument list of vlc_getaddrinfo(const char *node, unsigned port, const struct addrinfo *hints, struct addrinfo **res)

    src/network/getaddrinfo.c:69: warning: The following parameters of vlc_getaddrinfo(const char *node, unsigned port, const struct addrinfo *hints, struct addrinfo **res) are not documented:
      parameter 'port'
      parameter 'hints'

- - - - -
b1629834 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_picture: fix doxygen warning

    include/vlc_picture.h:452: warning: The following parameter of picture_GetAncillary(const picture_t *pic, vlc_ancillary_id id) is not documented:
      parameter 'pic'

- - - - -
c7429718 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_picture_pool: fix doxygen warnings

    include/vlc_picture_pool.h:111: warning: The following parameter of picture_pool_Reserve(picture_pool_t *master, unsigned count) is not documented:
      parameter 'master'

- - - - -
6917e530 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_picture_pool: remove trailing characters

- - - - -
16dfe02d by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_player: fix doxygen warnings

    include/vlc_player.h:2238: warning: The following parameter of vlc_player_AddMetadataListener(vlc_player_t *player, enum vlc_player_metadata_option option, const union vlc_player_metadata_cbs *cbs, void *cbs_data) is not documented:
      parameter 'option'

    include/vlc_player.h:132: warning: The following parameter of vlc_player_New(vlc_object_t *parent, enum vlc_player_lock_type lock_type, const struct vlc_player_media_provider *media_provider, void *media_provider_data) is not documented:
      parameter 'lock_type'

    include/vlc_player.h:897: warning: The following parameters of vlc_player_GetSignal(vlc_player_t *player, float *quality, float *strength) are not documented:
      parameter 'quality'
      parameter 'strength'

    include/vlc_player.h:790: warning: The following parameter of vlc_player_SetAtoBLoop(vlc_player_t *player, enum vlc_player_abloop abloop) is not documented:
      parameter 'abloop'

    include/vlc_player.h:1010: warning: The following parameter of vlc_player_title_list_GetAt(vlc_player_title_list *titles, size_t idx) is not documented:
      parameter 'titles'

- - - - -
ed1cf916 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_playlist: fix doxygen warnings

    include/vlc_playlist.h:873: warning: The following parameter of vlc_playlist_Export(vlc_playlist_t *playlist, const char *filename, const char *type) is not documented:
      parameter 'playlist'

    include/vlc_playlist.h:439: warning: Found unknown command '\index'

    include/vlc_playlist.h:436: warning: The following parameter of vlc_playlist_Insert(vlc_playlist_t *playlist, size_t index, input_item_t *const media[], size_t count) is not documented:
      parameter 'index'

    include/vlc_playlist.h:454: warning: Found unknown command '\index'

    include/vlc_playlist.h:451: warning: The following parameter of vlc_playlist_InsertOne(vlc_playlist_t *playlist, size_t index, input_item_t *media) is not documented:
      parameter 'index'

    include/vlc_playlist.h:565: warning: Found unknown command '\index'

    include/vlc_playlist.h:555: warning: The following parameter of vlc_playlist_RequestInsert(vlc_playlist_t *playlist, size_t index, input_item_t *const media[], size_t count) is not documented:
      parameter 'index'

- - - - -
a0e6fc35 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_queue: fix doxygen warnings

    include/vlc_queue.h:188: warning: The following parameter of vlc_queue_Enqueue(vlc_queue_t *q, void *entry) is not documented:
      parameter 'q'

    include/vlc_queue.h:130: warning: The following parameter of vlc_queue_EnqueueUnlocked(vlc_queue_t *q, void *entry) is not documented:
      parameter 'q'

- - - - -
740f65fb by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_renderer_discovery: fix doxygen warnings

    include/vlc_renderer_discovery.h:121: warning: The following parameter of vlc_rd_get_names(vlc_object_t *p_obj, char ***pppsz_names, char ***pppsz_longnames) is not documented:
      parameter 'p_obj'

    include/vlc_renderer_discovery.h:136: warning: The following parameters of vlc_rd_new(vlc_object_t *p_obj, const char *psz_name, const struct vlc_renderer_discovery_owner *owner) are not documented:
      parameter 'p_obj'
      parameter 'owner'

- - - - -
1ec8e4ef by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_services_discovery: fix doxygen warnings

    include/vlc_services_discovery.h:197: warning: The following parameters of services_discovery_AddItemCat(services_discovery_t *sd, input_item_t *item, const char *category) are not documented:
      parameter 'sd'
      parameter 'item'

    include/vlc_services_discovery.h:173: warning: The following parameter of services_discovery_AddSubItem(services_discovery_t *sd, input_item_t *parent, input_item_t *item) is not documented:
      parameter 'parent'

- - - - -
2982100b by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_spawn: fix doxygen warnings

    include/vlc_spawn.h:36: warning: argument 'path' of command @param is not found in the argument list of vlc_spawn(pid_t *pid, const char *file, const int *fdv, const char *const *argv)

    include/vlc_spawn.h:36: warning: The following parameter of vlc_spawn(pid_t *pid, const char *file, const int *fdv, const char *const *argv) is not documented:
      parameter 'file'

- - - - -
af1e428f by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_spu: fix doxygen warnings

  include/vlc_spu.h:70: warning: The following parameters of spu_Render(spu_t *spu, const vlc_fourcc_t *p_chroma_list, const video_format_t *p_fmt_dst, const video_format_t *p_fmt_src, vlc_tick_t system_now, vlc_tick_t pts, bool ignore_osd, bool external_scale) are not documented:
    parameter 'spu'
    parameter 'system_now'
    parameter 'pts'
    parameter 'ignore_osd'
    parameter 'external_scale'

- - - - -
d914c98f by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_spu: remove trailing characters

- - - - -
929f5c73 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_stream: fix doxygen warnings

      include/vlc_stream.h:319: warning: argument 'bufp' of command @param is not found in the argument list of vlc_stream_Peek(stream_t *, const uint8_t **, size_t)

      include/vlc_stream.h:319: warning: argument 'len' of command @param is not found in the argument list of vlc_stream_Peek(stream_t *, const uint8_t **, size_t)

      include/vlc_stream.h:287: warning: The following parameter of vlc_stream_Read(stream_t *s, void *buf, size_t len) is not documented:
        parameter 's'

      include/vlc_stream.h:302: warning: The following parameter of vlc_stream_ReadPartial(stream_t *s, void *buf, size_t len) is not documented:
        parameter 's'

      include/vlc_stream.h:389: warning: The following parameter of vlc_stream_Seek(stream_t *s, uint64_t offset) is not documented:
        parameter 's'

- - - - -
e168bdeb by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_stream: remove trailing characters

- - - - -
a6fd2db1 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_strings: fix doxygen warnings

    include/vlc_strings.h:97: warning: argument 'str' of command @param is not found in the argument list of vlc_xml_decode(char *st)

    include/vlc_strings.h:97: warning: The following parameter of vlc_xml_decode(char *st) is not documented:
      parameter 'st'

- - - - -
9cfc1a95 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_threads: fix doxygen warnings

    include/vlc_threads.h:434: warning: The following parameter of vlc_sem_init(vlc_sem_t *sem, unsigned count) is not documented:
      parameter 'sem'

    include/vlc_threads.h:515: warning: The following parameter of vlc_latch_count_down(vlc_latch_t *latch, size_t n) is not documented:
      parameter 'latch'

    include/vlc_threads.h:531: warning: The following parameter of vlc_latch_count_down_and_wait(vlc_latch_t *latch, size_t n) is not documented:
      parameter 'latch'

    include/vlc_threads.h:508: warning: The following parameter of vlc_latch_init(vlc_latch_t *latch, size_t value) is not documented:
      parameter 'latch'

- - - - -
aa71a098 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_thumbnailer: fix doxygen warnings

    include/vlc_thumbnailer.h:51: warning: argument 'parent' of command @param is not found in the argument list of vlc_thumbnailer_Create(vlc_object_t *p_parent)

    include/vlc_thumbnailer.h:51: warning: The following parameter of vlc_thumbnailer_Create(vlc_object_t *p_parent) is not documented:
      parameter 'p_parent'

- - - - -
21c10deb by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_tls: fix doxygen warnings

    include/vlc_tls.h:304: warning: The following parameter of
    vlc_tls_GetPollFD(vlc_tls_t *tls, short *events) is not documented:
        parameter 'tls'

    include/vlc_tls.h:335: warning: The following parameter of
    vlc_tls_Read(vlc_tls_t *session, void *buf, size_t len, bool waitall) is not documented:
        parameter 'session'

    include/vlc_tls.h:365: warning: The following parameter of
    vlc_tls_Shutdown(vlc_tls_t *tls, bool duplex) is not documented:
        parameter 'tls'

    include/vlc_tls.h:176: warning: argument 'hostname' of command @param is not found in the argument list of vlc_tls_ClientSessionCreate(vlc_tls_client_t *creds, vlc_tls_t *sock, const char *host, const char *service, const char *const *alpn, char **alp)

    include/vlc_tls.h:176: warning: The following parameter of vlc_tls_ClientSessionCreate(vlc_tls_client_t *creds, vlc_tls_t *sock, const char *host, const char *service, const char *const *alpn, char **alp) is not documented:
      parameter 'host'

    include/vlc_tls.h:237: warning: The following parameter of vlc_tls_ServerCreate(vlc_object_t *obj, const char *cert, const char *key) is not documented:
      parameter 'obj'

    include/vlc_tls.h:256: warning: The following parameter of vlc_tls_ServerSessionCreate(vlc_tls_server_t *creds, vlc_tls_t *sock, const char *const *alpn) is not documented:
      parameter 'sock'

- - - - -
09ead1c1 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_vout_display: fix doxygen warning on \ref

vout_display_cfg::display::fitting didn't refer to an existing reference
since Doxygen will not recursively create references to nested
structures, except if they are only defined in the structure.

- - - - -
5393f5d7 by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
vlc_window: fix doxygen warning

    include/vlc_window.h:539: warning: argument 'cfg' of command @param
    is not found in the argument list of vlc_window_Enable(vlc_window_t *window)

- - - - -
67481c9c by Alexandre Janniaux at 2023-08-03T08:56:58+00:00
doc: Doxyfile.in: expand VLC_OBJECT as-is

Fixes the following warnings:

    include/vlc_objects.h:246: warning: argument 'obj' of command @param is not found in the argument list of vlc_obj_calloc(_Generic((vlc_object_t *obj) ->obj, struct vlc_object_marker *:(vlc_object_t *obj), default:(&((vlc_object_t *obj) ->obj))), size_t nmemb, size_t size)

    include/vlc_objects.h:276: warning: argument 'obj' of command @param is not found in the argument list of vlc_obj_free(_Generic((vlc_object_t *obj) ->obj, struct vlc_object_marker *:(vlc_object_t *obj), default:(&((vlc_object_t *obj) ->obj))), void *ptr)

    include/vlc_objects.h:232: warning: argument 'obj' of command @param is not found in the argument list of vlc_obj_malloc(_Generic((vlc_object_t *obj) ->obj, struct vlc_object_marker *:(vlc_object_t *obj), default:(&((vlc_object_t *obj) ->obj))), size_t size)

    include/vlc_objects.h:262: warning: argument 'obj' of command @param is not found in the argument list of vlc_obj_strdup(_Generic((vlc_object_t *obj) ->obj, struct vlc_object_marker *:(vlc_object_t *obj), default:(&((vlc_object_t *obj) ->obj))), const char *str)

- - - - -


30 changed files:

- doc/Doxyfile.in
- doc/standalone/libvlc.md
- doc/standalone/mainpage.md
- doc/standalone/mrl.dox
- include/vlc_ancillary.h
- include/vlc_aout.h
- include/vlc_block.h
- include/vlc_charset.h
- include/vlc_cxx_helpers.hpp
- include/vlc_decoder.h
- include/vlc_demux.h
- include/vlc_dialog.h
- include/vlc_diffutil.h
- include/vlc_filter.h
- include/vlc_frame.h
- include/vlc_fs.h
- include/vlc_http.h
- include/vlc_input_item.h
- include/vlc_interrupt.h
- include/vlc_keystore.h
- include/vlc_media_library.h
- include/vlc_media_source.h
- include/vlc_memstream.h
- include/vlc_modules.h
- include/vlc_network.h
- include/vlc_picture.h
- include/vlc_picture_pool.h
- include/vlc_player.h
- include/vlc_playlist.h
- include/vlc_queue.h


The diff was not included because it is too large.


View it on GitLab: https://code.videolan.org/videolan/vlc/-/compare/63d0d80c43c974b39c2db327ffd3bfbfe5a35ef6...67481c9ceebb2c7da03b5aec20a736ec58146f3d

-- 
View it on GitLab: https://code.videolan.org/videolan/vlc/-/compare/63d0d80c43c974b39c2db327ffd3bfbfe5a35ef6...67481c9ceebb2c7da03b5aec20a736ec58146f3d
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