Marvin Scholz
0baa6871ac
avutil/aes: document some missing arguments
2022-10-17 09:56:47 +02:00
Marvin Scholz
0d34137925
avcodec/bsf: document missing arguments
2022-10-17 09:56:47 +02:00
Marvin Scholz
4aa04c255d
swscale: document some missing arguments
2022-10-17 09:56:47 +02:00
Marvin Scholz
a76d5fecf3
avutil/imgutils: document some missing arguments
2022-10-17 09:56:47 +02:00
Marvin Scholz
ed2aa4e692
avutil/crc: Add doxy for missing arguments
2022-10-17 09:56:47 +02:00
Marvin Scholz
96f89cdc87
avutil/des: Add doxy for missing arguments
...
Additionally reorder so that the arguments list matches the
order of the arguments in the function declaration.
2022-10-17 09:56:47 +02:00
Marvin Scholz
023966d2f8
avutil/avstring: Add doxy for missing argument
2022-10-17 09:56:47 +02:00
Marvin Scholz
20a947f479
avutil/frame: Add doxy for missing argument
2022-10-17 09:56:47 +02:00
Marvin Scholz
3dea9adc67
avutil/rc4: Add doxy for missing arguments
2022-10-17 09:56:47 +02:00
Marvin Scholz
0e7ce0d5e7
avutil/uuid: Remove bogus doxy return doc
...
The function returns void and no error code.
2022-10-17 09:56:47 +02:00
Marvin Scholz
c4ff708c81
avutil/parseutils: Use inline code and properly escape
...
For some reason doxygen needs the % to be escaped here, except for the
%% in the inline code…
2022-10-17 09:56:47 +02:00
Marvin Scholz
990340377b
avutil/parseutils: Add doxy for missing arguments
2022-10-17 09:56:47 +02:00
Marvin Scholz
8521a691b9
avutil/hwcontext: Add doxy for missing argument
2022-10-17 09:56:47 +02:00
Marvin Scholz
8bac3902b0
avutil/lfg: Minor doxy improvements
...
Use inline code for sizeof and use proper @return directive.
2022-10-17 09:56:47 +02:00
Marvin Scholz
6a1ad7a752
avutil/lfg: Add doxy for missing argument
2022-10-17 09:56:47 +02:00
Marvin Scholz
a679b87570
avutil/file: Add doxy for missing arguments
2022-10-17 09:56:47 +02:00
Marvin Scholz
b850347a89
avutil/eval: Add doxy for missing arguments
2022-10-17 09:56:47 +02:00
Marvin Scholz
27dbc9e724
avutil/detection_bbox: Add doxy for missing argument
2022-10-17 09:56:47 +02:00
Marvin Scholz
226dde687f
avformat/avio: Add doxy for missing argument
2022-10-17 09:56:47 +02:00
Marvin Scholz
60224f203f
avfilter: Fix doxy references
...
Doxygen does not properly form references that span multiple levels,
so instead reword it a bit and manually add the references to what
they should point to.
2022-10-17 09:56:44 +02:00
Marvin Scholz
436879a203
avutil/channel_layout: Document missing arguments
2022-10-17 09:55:19 +02:00
Marvin Scholz
f824388c33
avutil/channel_layout: Use inline code for Doxy
...
This avoids Doxygen to interpret <i> and others that look like XML tags
as those, fixing a warning about unknown tags.
2022-10-17 09:55:19 +02:00
Marvin Scholz
e3c5b8c610
avutil/camellia: Fix doxy @param typo
2022-10-17 09:55:19 +02:00
Marvin Scholz
1f59e71478
swresample: Fix Doxy reference to AVOptions
2022-10-17 09:55:19 +02:00
Marvin Scholz
58b86d8b68
avutil/bprint: Improve doxy documentation
...
Declare proper group, add the file to that group,
group the defines and document them.
Use lists to represents lists of cases.
2022-10-17 09:55:19 +02:00
Marvin Scholz
fe9381ede6
doc/Doxyfile: Add FF_PAD_STRUCTURE to PREDEFINED
...
The FF_PAD_STRUCTURE is too complex for doxygen to be able to
properly handle, resulting in completely broken AVBPrint documentation.
To fix that, tell Doxygen what to expand that macro to.
2022-10-17 09:55:19 +02:00
Marvin Scholz
80c8b988fb
avcodec/mediacodec: link to related documentation
2022-10-17 09:55:19 +02:00
Marvin Scholz
56bbfe1136
avcodec/mediacodec: use inline code for coderefs
...
Avoids doxy to interpret these as internal references forced by the #
character, fixing the warnings:
warning: explicit link request to 'nanoTime()' could not be resolved
warning: explicit link request to 'releaseOutputBuffer(int,long)'
could not be resolved
2022-10-17 09:55:19 +02:00
Marvin Scholz
aba8cf654f
swscale: Fix bogus doxy comment #ifdefs
...
The intention here was probably to document this as use of
conditionals does not make sense in a comment.
Fixes doxy warning:
warning: explicit link request to 'if' could not be resolved
2022-10-17 09:55:19 +02:00
Marvin Scholz
88e78ec6a8
avutil/csp: Fix bogus doxy filename
...
Separate the blocks to make the grouping easier to grasp,
add the file properly to the group and fix the file description
incorrectly used as filename, fixing the following doxy warning:
warning: the name 'Colorspace' supplied as the argument in
the \file statement is not an input file
2022-10-17 09:55:19 +02:00
Marvin Scholz
6938ddb167
avutil/stereo3d: Add file to doxy group
...
This way the related file will be properly grouped with its
corresponding group like it's done in other places in the doxy.
2022-10-17 09:55:19 +02:00
Marvin Scholz
06bcbe1477
avutil/stereo3d: consolidate group doxy
...
Make it a bit easier to grasp the grouping when not
unnecessarily splitting comment blocks.
Additionally do not try to add lavu_video_stereo3d to itself, resolving
the following doxy warning:
warning: Refusing to add group lavu_video_stereo3d to itself
2022-10-17 09:55:19 +02:00
Marvin Scholz
7e8d974487
avutil/spherical: Add file to doxy group
...
This way the related file will be properly grouped with its
corresponding group like it's done in other places in the doxy.
2022-10-17 09:55:19 +02:00
Marvin Scholz
24b610e366
avutil/spherical: consolidate group doxy
...
Make it a bit easier to grasp the grouping when not
unnecessarily splitting comment blocks.
Additionally do not try to add lavu_video_spherical to itself, resolving
the following doxy warning:
warning: Refusing to add group lavu_video_spherical to itself
2022-10-17 09:55:19 +02:00
Marvin Scholz
71c45b8a44
avutil/display: Add file to doxy group
...
This way the related file will be properly grouped with its
corresponding group like it's done in other places in the doxy.
2022-10-17 09:55:19 +02:00
Marvin Scholz
9570a833a0
avutil/display: consolidate group doxy
...
Make it a bit easier to grasp the grouping when not
unnecessarily splitting comment blocks.
Additionally do not try to add lavu_video_display to itself, resolving
the following doxy warning:
warning: Refusing to add group lavu_video_display to itself
2022-10-17 09:55:19 +02:00
Marvin Scholz
c2c4ef6ae4
avutil/aes_ctr: Add proper doxy group
...
So it will be properly listed along the other crypto modules
in the documentation.
2022-10-17 09:55:19 +02:00
Marvin Scholz
67298d8ea1
avcodec/videotoolbox: Add proper doxy group
...
Same as done for other HW decoders, that way it will be
properly listed on the relevant module page.
2022-10-17 09:55:16 +02:00
Marvin Scholz
4be6d065d4
avcodec/codec_par: Add missing doxy group opening
2022-10-17 09:51:47 +02:00
Marvin Scholz
295d217117
avcodec/vdpau: Fix doxy comment typo
...
This is clearly supposed to be a doxy comment and needed to properly
close the group.
2022-10-17 09:51:47 +02:00
Marvin Scholz
c468a8c04f
avutil/twofish: Fix doxy @param typo
2022-10-17 09:51:47 +02:00
Marvin Scholz
f29dde49d2
avutil/channel_layout: Group pre-defined channel layouts
2022-10-17 09:51:47 +02:00
Marvin Scholz
6c2ae2e994
avutil/channel_layout: Group deprecated functions
...
Makes it a bit easier to spot the deprecated ones when
looking at the overview.
2022-10-17 09:51:47 +02:00
Marvin Scholz
57c8722a47
avutil/channel_layout: Move to its own group
...
Before it was cluttering the general avutil Audio group page.
2022-10-17 09:51:47 +02:00
Marvin Scholz
2b51b1829d
avutil/channel_layout: Remove bogus closing group
2022-10-17 09:51:47 +02:00
Marvin Scholz
2c59038208
avcodec/avcodec: Escape Doxygen reference
...
The # is interpreted as explicit reference request by Doxygen
which is not desired here, use markdown inline code to avoid
that.
2022-10-17 09:51:47 +02:00
Marvin Scholz
99f6d0bdde
avformat/avformat: Improve doxy style
...
Mostly re-indenting and adding some missing references.
2022-10-17 09:51:47 +02:00
Marvin Scholz
eb60ffb144
swresample/swresample: Fix mismatching argument names
2022-10-17 09:51:47 +02:00
Marvin Scholz
3fbf8d6e1d
avutil: Fix mismatching argument names
2022-10-17 09:51:47 +02:00
Marvin Scholz
1f0529ec5f
avformat/avformat: Fix mismatching argument names
2022-10-17 09:51:47 +02:00
