Timothy Gu
f29ffbc87d
avutil/hash: Add more detailed Doxygen documentation
9 years ago
Timothy Gu
708d9e9fba
Doxyfile: Set STRIP_FROM_INC_PATH to project root
...
Show proper #include's on struct pages.
Before:
#include <buffer.h>
After
#include <libavutil/buffer.h>
9 years ago
Timothy Gu
fd2cde0234
Doxygen: Re-enable JAVADOC_AUTOBRIEF
9 years ago
Timothy Gu
cebad64d4f
Doxyfile: Reset unused options back to default
...
Silences a few warnings.
9 years ago
Timothy Gu
5522da9ee1
doxygen: Remove outdated EXPAND_AS_DEFINED
9 years ago
Timothy Gu
7204a6298b
doxygen: Set tab size to 4
9 years ago
Timothy Gu
6253e5676f
doxygen: Update Doxyfile for Doxygen 1.8.8
9 years ago
Timothy Gu
f198b8af72
doxygen: Fix PREDEFINED syntax
9 years ago
Lou Logan
06eef96b69
fix some a/an typos
...
Signed-off-by: Lou Logan <lou@lrcd.com>
9 years ago
Diego Biurrun
48362ceade
doc: Update paths to match new examples location
9 years ago
James Almer
36e1665d3d
avutil/attributes: add AV_GCC_VERSION_AT_MOST
...
Reviewed-by: Michael Niedermayer <michaelni@gmx.at>
Signed-off-by: James Almer <jamrial@gmail.com>
9 years ago
Michael Niedermayer
9ccc7aeeea
doc/Doxyfile: use 5 columns for alphabetical index
...
This reverts a hunk from 671005558a
Reduces diff to what we use on the server
Suggested-by: Timothy Gu
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
11 years ago
Timothy Gu
939d22a297
Doxyfile: imitate gcc for better libavutil/attributes.h documentation
...
Signed-off-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
11 years ago
Timothy Gu
31a6dfcbf7
Doxyfile: enable browser-based search engine
...
Signed-off-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
11 years ago
Diego Biurrun
19d3127867
doxygen: Set EXAMPLE_PATH from within doxy-wrapper.sh
...
This allows using the libav source path as the example path.
11 years ago
Diego Biurrun
e6c175dfd5
Doxyfile: Only set HTML_{HEADER|FOOTER|STYLESHEET} from doxy_wrapper.sh
11 years ago
Thilo Borgmann
f18ccb529f
Fix wrong use of "an" in some comments.
12 years ago
Michael Niedermayer
a37e42b3ee
Update back for git master
...
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
12 years ago
Michael Niedermayer
1ebb95d5f1
Update for 2.0
...
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
12 years ago
Anton Khirnov
e69222c507
doxy: enable TYPEDEF_HIDES_STRUCT
...
This means that typedef struct SomeStruct {...} SomeStruct will only be
documented as SomeStruct in the doxy, without a pointless entry in the
typedefs list.
12 years ago
Anton Khirnov
e27f4b7cbf
doxy: don't sort struct members alphabetically
...
The declaration order is more meanigful in most cases.
12 years ago
Michael Niedermayer
a9f8182a9d
doxygen: dont strip code comments
...
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
12 years ago
Diego Biurrun
511cf612ac
miscellaneous typo fixes
12 years ago
Janne Grunau
116ae7285e
doxygen: remove obsolete options from Doxyfile
...
The options USE_INLINE_TREES, SHOW_DIRECTORIES and HTML_ALIGN_MEMBERS
became obsolete with doxygen 1.8.1 (releaded 2012-05-19). The generated
outpu for older doxygen versions should not change since they were set
to the default value.
12 years ago
Diego Biurrun
13bbefd57e
doxygen: Add av_alloc_size to list of predefined macros
...
This avoids Doxygen believing the attribute is the function name.
12 years ago
Diego Biurrun
74e742d6ad
doxygen: Drop some pointless entries from PREDEFINED macros list
12 years ago
Stefano Sabatini
a161def1e4
Doxyfile: update examples path and patterns
12 years ago
Michael Niedermayer
7d0ca5b7e4
doxygen: disable header/footer/stylesheet
...
They dont work at all and trash the output totally
also they are unmaintained -> that is if you want to maintain them
contact us !
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
12 years ago
Diego Biurrun
5e28e97433
Move Doxyfile into the doc/ subdirectory
12 years ago
Diego Biurrun
d7a39b3340
doxygen: Build Doxygen documentation in the doc/ subdirectory
12 years ago
Diego Biurrun
239fdf1b4a
x86: build: replace mmx2 by mmxext
...
Refactoring mmx2/mmxext YASM code with cpuflags will force renames.
So switching to a consistent naming scheme beforehand is sensible.
The name "mmxext" is more official and widespread and also the name
of the CPU flag, as reported e.g. by the Linux kernel.
13 years ago
Lou Logan
935c659c03
remove avconv from Doxyfile
...
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
13 years ago
Diego Biurrun
5ea20630b4
Fix a bunch of platform name and other typos.
13 years ago
Gautam Gupta
671005558a
doxy: add website-alike style to the html output
...
Signed-off-by: Luca Barbato <lu_zero@gentoo.org>
13 years ago
Hanspeter Niederstrasser
bed04e2b03
Correct use of OSX to Mac OS X and properly format yasm providers on Mac OS X
...
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
13 years ago
Luca Barbato
b73a01eaf1
doxy: change hue value to match our green
13 years ago
Michael Niedermayer
6337de9252
doxygen: dont generate docs for avconv.c
...
This is a workaround to avoid links in the ffmpeg.c documentation randomly pointing to
different code in avconv.c
This should be removed once doxygen is fixed and we upgraded
doxygen 1.7.3 is the latests i tested and that still has this issue.
Fixed Ticket421
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
13 years ago
Diego Biurrun
d0fcf39f0c
doxygen: Move function documentation into the macro generating the function.
...
This fixes a bunch of related warnings where Doxygen assumed that the
documentation belonged to the macro and not the function.
14 years ago
Reinhard Tartler
10dde477c7
Update Doxyfile to the format preferred by Doxygen 1.7.1 (via 'doxygen -u').
...
This is the version available in Debian stable, so it should be a reasonable
baseline that can be expected to be present on all developer machines.
Moreover, this is the version that is used by the nightly cronjob that
generates the online html version.
14 years ago
Reinhard Tartler
7655cfb1b8
doxygen: be more permissive when searching for API examples
14 years ago
Reinhard Tartler
807aa2d8f3
doxygen: Help doxygen parser to understand the DECLARE_ALIGNED and offsetof macros
...
Without this, members that have been declare with the DECLARE_ALIGNED
macro don't show up at all in the generated documentation.
14 years ago
Reinhard Tartler
d7537a6fce
doxygen: Include libavcodec and libavformat examples into the documentation
14 years ago
Janne Grunau
faa6f1c306
get rid of the last svn mentions
14 years ago
Michael Niedermayer
c0b1bc8d17
Revert "partially rename FFmpeg to Libav"
...
This reverts commit 070c5d0f35
.
14 years ago
Janne Grunau
070c5d0f35
partially rename FFmpeg to Libav
...
update mailing list references and irc channels in configure
14 years ago
Diego Biurrun
65415bb93a
Do not generate LaTeX Doxygen documentation by default.
...
Our general use case just requires HTML documentation, so skip the extra step.
Originally committed as revision 24216 to svn://svn.ffmpeg.org/ffmpeg/trunk
15 years ago
Diego Biurrun
655a29e712
Turn off the useless default chatter that doxygen prints to the console.
...
Originally committed as revision 24215 to svn://svn.ffmpeg.org/ffmpeg/trunk
15 years ago
Diego Biurrun
ad9eff3f9c
Do not generate documentation for .d files; they do not contain source code.
...
Originally committed as revision 24122 to svn://svn.ffmpeg.org/ffmpeg/trunk
15 years ago
Diego Biurrun
ac7a4056ad
Update Doxyfile to the format preferred by Doxygen 1.5.6 (via 'doxygen -u').
...
This is the version available in Debian stable, so it should be a reasonable
baseline that can be expected to be present on all developer machines.
Originally committed as revision 24064 to svn://svn.ffmpeg.org/ffmpeg/trunk
15 years ago
Diego Biurrun
f31abc6c66
cosmetics: Reformat paragraphs and fix typos as done by 'doxygen -u'.
...
Originally committed as revision 24063 to svn://svn.ffmpeg.org/ffmpeg/trunk
15 years ago