[vlc-commits] [Git][videolan/vlc][master] 34 commits: access: rtp: fix doxygen warnings

Thu Aug 10 10:34:12 UTC 2023

Steve Lhomme pushed to branch master at VideoLAN / VLC

Commits:
544a2835 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
access: rtp: fix doxygen warnings

    modules/access/rtp/rtp.h:324: warning: argument 'in' of command @param is not found in the argument list of vlc_rtp_parser_cb(vlc_object_t *obj, struct vlc_rtp_pt *pt, const struct vlc_sdp_pt *desc)

- - - - -
49b52633 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
access: rtp/session: fix superfluous doxygen group

There was no grouping in this file anyway.

- - - - -
ba7d4d8f by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
aout_internal.h: move documentation from source file

- - - - -
8d3a549d by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
aout_internal.h: fix doxygen warnings

    src/audio_output/output.c:679: warning: argument 'output_codec' of command @param is not found in the argument list of aout_OutputNew(audio_output_t *aout, vlc_aout_stream *stream, audio_sample_format_t *fmt, int input_profile, audio_sample_format_t *filter_fmt, aout_filters_cfg_t *filters_cfg)

    src/audio_output/output.c:679: warning: The following parameters of aout_OutputNew(audio_output_t *aout, vlc_aout_stream *stream, audio_sample_format_t *fmt, int input_profile, audio_sample_format_t *filter_fmt, aout_filters_cfg_t *filters_cfg) are not documented:
      parameter 'aout'
      parameter 'stream'
      parameter 'fmt'
      parameter 'input_profile'
      parameter 'filter_fmt'
      parameter 'filters_cfg'

- - - - -
342fa1df by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
audio_output: filters: fix parameter name for doc

Fix doxygen warning:

    src/audio_output/filters.c:168: warning: argument 'filters' of command @param is not found in the argument list of aout_FiltersPipelineCreate(vlc_object_t *obj, struct aout_filter *tab, unsigned *count, unsigned max, const audio_sample_format_t *restrict infmt, const audio_sample_format_t *restrict outfmt)

    src/audio_output/filters.c:168: warning: The following parameter of aout_FiltersPipelineCreate(vlc_object_t *obj, struct aout_filter *tab, unsigned *count, unsigned max, const audio_sample_format_t *restrict infmt, const audio_sample_format_t *restrict outfmt) is not documented:
      parameter 'tab'

- - - - -
42ec7266 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
audio_output: output: document missing parameter

    src/audio_output/output.c:84: warning: The following parameter of aout_VolumeNotify(audio_output_t *aout, float volume) is not documented:
      parameter 'aout'

- - - - -
0072ccf3 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
clock/clock.h: fix doxygen warnings

    src/clock/clock.h:141: warning: The following parameters of vlc_clock_Update(vlc_clock_t *clock, vlc_tick_t system_now, vlc_tick_t ts, double rate) are not documented:
      parameter 'clock'
      parameter 'ts'
      parameter 'rate'

- - - - -
2fa72e37 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
config: cmdline: fix documentation name for param

Fix doxygen warning:

    src/config/cmdline.c:154: warning: argument 'ppsz_args' of command @param is not found in the argument list of config_LoadCmdLine(libvlc_int_t *p_this, int i_argc, const char *ppsz_argv[], int *pindex)

    src/config/cmdline.c:154: warning: The following parameter of config_LoadCmdLine(libvlc_int_t *p_this, int i_argc, const char *ppsz_argv[], int *pindex) is not documented:
      parameter 'ppsz_argv'

- - - - -
d00fe398 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
config: core: fix documentation param name

    src/config/core.c:475: warning: argument 'config' of command @param is not found in the argument list of config_Free(struct vlc_param *tab, size_t confsize)

    src/config/core.c:475: warning: The following parameter of config_Free(struct vlc_param *tab, size_t confsize) is not documented:
      parameter 'tab'

- - - - -
37992b9f by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
config: jaro_winkler: remove duplicated documentation

    src/config/jaro_winkler.c:149: warning: argument 'a' from the argument list of vlc_jaro_winkler has multiple @param documentation sections

    src/config/jaro_winkler.c:149: warning: argument 'b' from the argument list of vlc_jaro_winkler has multiple @param documentation sections

    src/config/jaro_winkler.c:149: warning: argument 'res' from the argument list of vlc_jaro_winkler has multiple @param documentation sections

- - - - -
d3a4be84 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
filesystem.c: fix doxygen warnings

    src/text/filesystem.c:179: warning: argument 'pointer' of command @param is not found in the argument list of vlc_scandir(const char *dirname, char ***namelist, int(*select)(const char *), int(*compar)(const char **, const char **))

    src/text/filesystem.c:179: warning: The following parameters of vlc_scandir(const char *dirname, char ***namelist, int(*select)(const char *), int(*compar)(const char **, const char **)) are not documented:
      parameter 'namelist'
      parameter 'select'
      parameter 'compar'

- - - - -
6b74de62 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
http: file: fix doxygen warning

    modules/access/http/file.h:69: warning: The following parameter of vlc_http_file_seek(struct vlc_http_resource *res, uintmax_t offset) is not documented:
      parameter 'res'

- - - - -
40cc1071 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
http: h2conn: fix doxygen warnings

    modules/access/http/h2conn.c:497: warning: The following parameters of vlc_h2_stream_open(struct vlc_http_conn *c, const struct vlc_http_msg *msg, bool has_data) are not documented:
      parameter 'c'
      parameter 'has_data'

- - - - -
6881bd2e by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
http: message: fix doxygen warnings

    modules/access/http/message.h:165: warning: The following parameter of vlc_http_msg_add_creds_basic(struct vlc_http_msg *m, bool proxy, const char *username, const char *password) is not documented:
      parameter 'm'

    modules/access/http/message.h:112: warning: The following parameter of vlc_http_msg_add_time(struct vlc_http_msg *m, const char *name, const time_t *t) is not documented:
      parameter 'm'

    modules/access/http/message.h:104: warning: The following parameter of vlc_http_msg_get_time(const struct vlc_http_msg *m, const char *name) is not documented:
      parameter 'm'

    modules/access/http/message.h:231: warning: The following parameter of vlc_http_msg_get_token(const struct vlc_http_msg *msg, const char *field, const char *token) is not documented:
      parameter 'msg'

    modules/access/http/message.h:303: warning: The following parameter of vlc_http_msg_write(struct vlc_http_msg *m, block_t *b, bool eos) is not documented:
      parameter 'm'

- - - - -
613cea65 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
input_clock.h: fix doxygen warning

    src/clock/input_clock.h:46: warning: The following parameter of input_clock_AttachListener(input_clock_t *cl, vlc_clock_t *clock_listener) is not documented:
      parameter 'cl'

    src/clock/input_clock.h:64: warning: The following parameters of input_clock_Update(input_clock_t *cl, vlc_object_t *p_log, bool b_can_pace_control, bool b_buffering_allowed, vlc_tick_t i_clock, vlc_tick_t i_system) are not documented:
      parameter 'cl'
      parameter 'p_log'
      parameter 'b_can_pace_control'
      parameter 'i_clock'
      parameter 'i_system'

- - - - -
e670ebe8 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
input: decoder: fix documentation

    src/input/decoder.c:1841: warning: argument 'p_input' of command @param is not found in the argument list of CreateDecoder(vlc_object_t *p_parent, const struct vlc_input_decoder_cfg *cfg)

    src/input/decoder.c:1841: warning: argument 'p_es' of command @param is not found in the argument list of CreateDecoder(vlc_object_t *p_parent, const struct vlc_input_decoder_cfg *cfg)

    src/input/decoder.c:1841: warning: argument 'b_packetizer' of command @param is not found in the argument list of CreateDecoder(vlc_object_t *p_parent, const struct vlc_input_decoder_cfg *cfg)

    src/input/decoder.c:1841: warning: The following parameters of CreateDecoder(vlc_object_t *p_parent, const struct vlc_input_decoder_cfg *cfg) are not documented:
      parameter 'p_parent'
      parameter 'cfg'

    src/input/decoder.c:1691: warning: argument 'p_dec' of command @param is not found in the argument list of DecoderThread(void *p_data)

    src/input/decoder.c:1691: warning: The following parameter of DecoderThread(void *p_data) is not documented:
      parameter 'p_data'

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

    src/input/decoder.c:1558: warning: The following parameter of DecoderThread_ProcessInput(vlc_input_decoder_t *p_owner, vlc_frame_t *frame) is not documented:
      parameter 'p_owner'

    src/input/decoder.c:1996: warning: argument 'p_dec' of command @param is not found in the argument list of DeleteDecoder(vlc_input_decoder_t *p_owner, enum es_format_category_e i_cat)

    src/input/decoder.c:1996: warning: The following parameters of DeleteDecoder(vlc_input_decoder_t *p_owner, enum es_format_category_e i_cat) are not documented:
      parameter 'p_owner'
      parameter 'i_cat'

    src/input/decoder.c:1996: warning: found documented return type for DeleteDecoder that does not return anything

    src/input/decoder.c:2165: warning: argument 'p_input' of command @param is not found in the argument list of vlc_input_decoder_New(vlc_object_t *parent, const struct vlc_input_decoder_cfg *cfg)

    src/input/decoder.c:2165: warning: argument 'p_es' of command @param is not found in the argument list of vlc_input_decoder_New(vlc_object_t *parent, const struct vlc_input_decoder_cfg *cfg)

    src/input/decoder.c:2165: warning: The following parameters of vlc_input_decoder_New(vlc_object_t *parent, const struct vlc_input_decoder_cfg *cfg) are not documented:
      parameter 'parent'
      parameter 'cfg'

    src/input/decoder.c:2165: warning: argument 'p_input' of command @param is not found in the argument list of vlc_input_decoder_New(vlc_object_t *parent, const struct vlc_input_decoder_cfg *cfg)

    src/input/decoder.c:2165: warning: argument 'p_es' of command @param is not found in the argument list of vlc_input_decoder_New(vlc_object_t *parent, const struct vlc_input_decoder_cfg *cfg)

    src/input/decoder.c:2165: warning: The following parameters of vlc_input_decoder_New(vlc_object_t *parent, const struct vlc_input_decoder_cfg *cfg) are not documented:
      parameter 'parent'
      parameter 'cfg'

- - - - -
0d439f0e by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
input: es_out: fix documentation warnings

    src/input/es_out.c:2607: warning: found documented return type for EsOutSelect that does not return anything

    src/input/es_out.c:3148: warning: The following parameter of EsOutVaControlLocked(es_out_t *out, input_source_t *source, int i_query, va_list args) is not documented:
      parameter 'source'

- - - - -
9e955f5b by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
input: fix doxygen warnings

    src/input/input.c:210: warning: The following parameters of input_Create(vlc_object_t *p_parent, input_thread_events_cb events_cb, void *events_data, input_item_t *p_item, enum input_type type, input_resource_t *p_resource, vlc_renderer_item_t *p_renderer) are not documented:
      parameter 'events_cb'
      parameter 'events_data'
      parameter 'type'
      parameter 'p_renderer'

    src/input/input.c:117: warning: argument 'the' of command @param is not found in the argument list of input_Start(input_thread_t *p_input)

    src/input/input.c:117: warning: The following parameter of input_Start(input_thread_t *p_input) is not documented:
      parameter 'p_input'

    src/input/input.c:210: warning: The following parameters of input_Create(vlc_object_t *p_parent, input_thread_events_cb events_cb, void *events_data, input_item_t *p_item, enum input_type type, input_resource_t *p_resource, vlc_renderer_item_t *p_renderer) are not documented:
      parameter 'events_cb'
      parameter 'events_data'
      parameter 'type'
      parameter 'p_renderer'

    src/input/input.c:117: warning: argument 'the' of command @param is not found in the argument list of input_Start(input_thread_t *p_input)

    src/input/input.c:117: warning: The following parameter of input_Start(input_thread_t *p_input) is not documented:
      parameter 'p_input'

- - - - -
cc6785f0 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
input: input_internal.h: move documentation from source

- - - - -
9c322882 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
input: stats: fix documentation parameter name

Fix doxygen warnings:

    src/input/stats.c:117: warning: argument 'p_counter' of command @param is not found in the argument list of input_rate_Add(input_rate_t *counter, uintmax_t val)

    src/input/stats.c:117: warning: The following parameter of input_rate_Add(input_rate_t *counter, uintmax_t val) is not documented:
      parameter 'counter'

- - - - -
4a3471fa by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
input: subtitles: fix doxygen parameter name

Fix doxygen warnings:

    src/input/subtitles.c:207: warning: argument 'pp_slaves' of command @param is not found in the argument list of
    subtitles_Detect(input_thread_t *p_this, char *psz_path, const char *psz_name_org, input_item_slave_t ***ppp_slaves, int *p_slaves)

    src/input/subtitles.c:207: warning: The following parameter of subtitles_Detect(input_thread_t *p_this, char *psz_path,
    const char *psz_name_org, input_item_slave_t ***ppp_slaves, int *p_slaves) is not documented:
      parameter 'ppp_slaves'

- - - - -
c8494cf4 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
interface: fix doxygen warnings

    src/interface/interface.c:128: warning: argument 'playlist' of command @param is not found in the argument list of intf_Create(libvlc_int_t *libvlc, const char *chain)

    src/interface/interface.c:128: warning: The following parameter of intf_Create(libvlc_int_t *libvlc, const char *chain) is not documented:
      parameter 'libvlc'

- - - - -
655e392b by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
misc: actions: add missing documentation parameter

Fix doxygen warnings:

    src/misc/actions.c:493: warning: The following parameter of init_action(vlc_object_t *obj,
    void **map, const char *confname, vlc_action_id_t action) is not documented:
      parameter 'obj'

- - - - -
aef9ab84 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
misc: interrupt: add missing documentation field

Fix doxygen warnings:

    src/misc/interrupt.c:109: warning: The following parameter of vlc_interrupt_prepare(
    vlc_interrupt_t *ctx, void(*cb)(void *), void *data) is not documented:
      parameter 'ctx'

- - - - -
b6aa2b85 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
misc: interrupt: remove trailing characters

- - - - -
1f102b8f by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
misc: messages: fix doxygen warnings

    src/misc/messages.c:548: warning: argument 'data' of command @param is not found in the argument list of vlc_LogSet(libvlc_int_t *vlc, const struct vlc_logger_operations *ops, void *opaque)

    src/misc/messages.c:548: warning: The following parameters of vlc_LogSet(libvlc_int_t *vlc, const struct vlc_logger_operations *ops, void *opaque) are not documented:
      parameter 'vlc'
      parameter 'opaque'

- - - - -
80dd0577 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
misc: update: fix doxygen warnings

    src/misc/update.c:158: warning: found documented return type for EmptyRelease that does not return anything

    src/misc/update.c:385: warning: found documented return type for update_Check that does not return anything

    src/misc/update.c:129: warning: found documented return type for update_Delete that does not return anything

    src/misc/update.c:496: warning: argument 'dir' of command @param is not found in the argument list of update_Download(update_t *p_update, const char *psz_destdir)

    src/misc/update.c:496: warning: The following parameter of update_Download(update_t *p_update, const char *psz_destdir) is not documented:
      parameter 'psz_destdir'

    src/misc/update.c:496: warning: found documented return type for update_Download that does not return anything

- - - - -
c5ab96f0 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
modules: bank: fix doxygen warnings

    src/modules/bank.c:799: warning: argument 'p_this' of command @param is not found in the argument list of module_LoadPlugins(libvlc_int_t *obj)

    src/modules/bank.c:799: warning: The following parameter of module_LoadPlugins(libvlc_int_t *obj) is not documented:
      parameter 'obj'

- - - - -
f19a884d by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
modules: fix doxygen warnings

    src/modules/modules.h:158: warning: argument 'name' of command @param is not found in the argument list of vlc_dlsym(void *handle, const char *psz_function)

    src/modules/modules.h:158: warning: The following parameter of vlc_dlsym(void *handle, const char *psz_function) is not documented:
      parameter 'psz_function'

- - - - -
f78f1299 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
modules: remove duplicated documentation

The documentation was already present in vlc_modules.h.

- - - - -
6fce164a by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
sap.c: fix doxygen warnings

    src/stream_output/sap.c:121: warning: argument 'p_this' of command @param is not found in the argument list of RunThread(void *self)

    src/stream_output/sap.c:121: warning: The following parameter of RunThread(void *self) is not documented:
      parameter 'self'

- - - - -
cae49de8 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
srtp: fix doxygen warnings

    modules/access/rtp/srtp.c:713: warning: The following parameter of srtcp_crypt(srtp_session_t *s, uint8_t *buf, size_t len) is not documented:
      parameter 's'

    modules/access/rtp/srtp.c:812: warning: The following parameter of srtcp_recv(srtp_session_t *s, uint8_t *buf, size_t *lenp) is not documented:
      parameter 's'

    modules/access/rtp/srtp.c:771: warning: The following parameter of srtcp_send(srtp_session_t *s, uint8_t *buf, size_t *lenp, size_t bufsize) is not documented:
      parameter 's'

    modules/access/rtp/srtp.c:122: warning: The following parameter of srtp_create(int encr, int auth, unsigned tag_len, int prf, unsigned flags) is not documented:
      parameter 'prf'

    modules/access/rtp/srtp.c:454: warning: The following parameter of srtp_crypt(srtp_session_t *s, uint8_t *buf, size_t len) is not documented:
      parameter 's'

    modules/access/rtp/srtp.c:536: warning: Unsupported xml/html tag <lenp> found

    modules/access/rtp/srtp.c:526: warning: The following parameter of srtp_send(srtp_session_t *s, uint8_t *buf, size_t *lenp, size_t bufsize) is not documented:
      parameter 's'

    modules/access/rtp/srtp.c:365: warning: The following parameter of srtp_setrcc_rate(srtp_session_t *s, uint16_t rate) is not documented:
      parameter 's'

    modules/access/rtp/srtp.c:614: warning: The following parameter of srtp_recv(srtp_session_t *s, uint8_t *buf, size_t *lenp) is not documented:
      parameter 's'

- - - - -
d2b1b063 by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
variable: fix doxygen warning

    src/misc/variables.c:904: warning: found documented return type for
    var_OptionParse that does not return anything

- - - - -
7e75cb6e by Alexandre Janniaux at 2023-08-10T09:30:35+00:00
vout_subpictures: fix doxygen warnings

    src/video_output/vout_subpictures.c:1635: warning: argument 'p_this' of command @param is not found in the argument list of spu_Create(vlc_object_t *object, vout_thread_t *vout)

    src/video_output/vout_subpictures.c:1635: warning: The following parameters of spu_Create(vlc_object_t *object, vout_thread_t *vout) are not documented:
      parameter 'object'
      parameter 'vout'

    src/video_output/vout_subpictures.c:1615: warning: argument 'p_this' of command @param is not found in the argument list of spu_Destroy(spu_t *spu)

    src/video_output/vout_subpictures.c:1615: warning: The following parameter of spu_Destroy(spu_t *spu) is not documented:
      parameter 'spu'

- - - - -

30 changed files:

- modules/access/http/file.h
- modules/access/http/h2conn.c
- modules/access/http/message.h
- modules/access/rtp/rtp.h
- modules/access/rtp/session.c
- modules/access/rtp/srtp.c
- src/audio_output/aout_internal.h
- src/audio_output/filters.c
- src/audio_output/output.c
- src/clock/clock.h
- src/clock/input_clock.h
- src/config/cmdline.c
- src/config/core.c
- src/config/jaro_winkler.c
- src/input/decoder.c
- src/input/es_out.c
- src/input/input.c
- src/input/input_internal.h
- src/input/stats.c
- src/input/subtitles.c
- src/interface/interface.c
- src/misc/actions.c
- src/misc/interrupt.c
- src/misc/messages.c
- src/misc/update.c
- src/misc/variables.c
- src/modules/bank.c
- src/modules/modules.c
- src/modules/modules.h
- src/stream_output/sap.c

The diff was not included because it is too large.

View it on GitLab: https://code.videolan.org/videolan/vlc/-/compare/4cd819e2389b5ad1389f401f0e39825c65c13abd...7e75cb6e49eeca66418fbe219476d970a1030134

-- 
View it on GitLab: https://code.videolan.org/videolan/vlc/-/compare/4cd819e2389b5ad1389f401f0e39825c65c13abd...7e75cb6e49eeca66418fbe219476d970a1030134
You're receiving this email because of your account on code.videolan.org.

VideoLAN code repository instance