Commit Graph

36 Commits

Author SHA1 Message Date
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
Andreas Cadhalpun c8a6eb58d7 doc: fix spelling errors
Thanks to Mathieu Malaterre <malat@debian.org> for reporting the
Que/Queue typo. (https://bugs.debian.org/839542)

Reviewed-by: Lou Logan <lou@lrcd.com>
Signed-off-by: Andreas Cadhalpun <Andreas.Cadhalpun@googlemail.com>
2016-10-21 23:58:47 +02:00
Timothy Gu f29ffbc87d avutil/hash: Add more detailed Doxygen documentation 2016-08-02 21:49:52 -07:00
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>
2016-08-02 15:53:53 -07:00
Timothy Gu fd2cde0234 Doxygen: Re-enable JAVADOC_AUTOBRIEF 2016-07-31 20:56:23 -07:00
Timothy Gu cebad64d4f Doxyfile: Reset unused options back to default
Silences a few warnings.
2016-07-30 19:52:28 -07:00
Timothy Gu 5522da9ee1 doxygen: Remove outdated EXPAND_AS_DEFINED 2016-07-30 19:52:24 -07:00
Timothy Gu 7204a6298b doxygen: Set tab size to 4 2016-07-29 19:01:40 -07:00
Timothy Gu 6253e5676f doxygen: Update Doxyfile for Doxygen 1.8.8 2016-07-29 19:01:40 -07:00
Timothy Gu f198b8af72 doxygen: Fix PREDEFINED syntax 2016-07-29 19:01:40 -07:00
Lou Logan 06eef96b69 fix some a/an typos
Signed-off-by: Lou Logan <lou@lrcd.com>
2016-03-28 14:13:17 -08:00
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>
2015-09-18 12:41:29 -03:00
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>
2014-07-08 00:43:18 +02:00
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>
2014-07-04 23:14:17 +02:00
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>
2014-07-04 21:35:29 +02:00
Michael Niedermayer c0c6f9aba5 Merge commit 'e6c175dfd51e4b0e6deeae72cd8a161b22af3492'
* commit 'e6c175dfd51e4b0e6deeae72cd8a161b22af3492':
  Doxyfile: Only set HTML_{HEADER|FOOTER|STYLESHEET} from doxy_wrapper.sh

Conflicts:
	doc/Doxyfile

See: 7d0ca5b7e4
Merged-by: Michael Niedermayer <michaelni@gmx.at>
2014-02-14 14:38:21 +01:00
Diego Biurrun e6c175dfd5 Doxyfile: Only set HTML_{HEADER|FOOTER|STYLESHEET} from doxy_wrapper.sh 2014-02-14 11:07:35 +01:00
Thilo Borgmann f18ccb529f Fix wrong use of "an" in some comments. 2013-08-12 03:27:26 +02:00
Michael Niedermayer a37e42b3ee Update back for git master
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2013-07-10 03:14:23 +02:00
Michael Niedermayer 1ebb95d5f1 Update for 2.0
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2013-07-10 02:15:43 +02:00
Michael Niedermayer ecbd96ed23 Merge commit 'e69222c50755030eef921e899e38b71a111093d9'
* commit 'e69222c50755030eef921e899e38b71a111093d9':
  doxy: enable TYPEDEF_HIDES_STRUCT

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-05-24 12:25:21 +02:00
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.
2013-05-24 09:12:00 +02:00
Michael Niedermayer 937af7f6d3 Merge commit 'e27f4b7cbf8a3fde313cfe4b3a1880bf5031e9ae'
* commit 'e27f4b7cbf8a3fde313cfe4b3a1880bf5031e9ae':
  doxy: don't sort struct members alphabetically

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2013-05-18 11:35:51 +02:00
Anton Khirnov e27f4b7cbf doxy: don't sort struct members alphabetically
The declaration order is more meanigful in most cases.
2013-05-17 20:27:52 +02:00
Michael Niedermayer a9f8182a9d doxygen: dont strip code comments
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
2013-03-31 22:34:13 +02:00
Michael Niedermayer d27edc038a Merge commit '511cf612ac979f536fd65e14603a87ca5ad435f3'
* commit '511cf612ac979f536fd65e14603a87ca5ad435f3':
  miscellaneous typo fixes

Conflicts:
	libavcodec/4xm.c
	libavcodec/lagarith.c
	libavcodec/parser.c
	libavcodec/ratecontrol.c
	libavcodec/shorten.c
	libavcodec/vda_h264.c
	libavformat/dvenc.c
	libavformat/wtv.c
	tools/patcheck

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2012-12-21 17:32:52 +01:00
Diego Biurrun 511cf612ac miscellaneous typo fixes 2012-12-21 00:18:34 +01:00
Michael Niedermayer 3db32ec119 Merge commit 'bf5f46b4cc47b7a4568119f224057d4ff91b6cdd'
* commit 'bf5f46b4cc47b7a4568119f224057d4ff91b6cdd':
  APIChanges: add entry for av_read_packet deprecation
  mxfdec: fix typo in mxf_read_seek()
  avserver: use freopen to redirect stdin/out/err to /dev/null
  avserver: remove daemon mode
  configure: Check for -Werror parameters on clang
  doxygen: remove obsolete options from Doxyfile
  configure: Add option to disable all command line programs

Conflicts:
	Changelog
	configure
	doc/APIchanges
	doc/ffserver.conf
	doc/ffserver.texi
	ffserver.c

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2012-11-16 13:07:10 +01:00
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.
2012-11-15 17:18:37 +01:00
Michael Niedermayer 95760b33e7 Merge remote-tracking branch 'qatar/master'
* qatar/master:
  configure: fix tests for 2-arg math functions
  doc: git-howto: Clarify comment about pushing series of commits
  ivi_common: Drop unused function parameter from decode_band()
  cook: Remove some silly Doxygen comments
  cook: Remove senseless maybe_reformat_buffer32() function
  cook: cosmetics: Better names for joint_decode() function parameters
  cook: cosmetics: Better name for ccpl COOKSubpacket member
  doxygen: Add av_alloc_size to list of predefined macros
  doxygen: Drop some pointless entries from PREDEFINED macros list
  h263: avoid memcpys over array bound in motion vector caching for obmc

Conflicts:
	configure
	doc/git-howto.texi
	libavcodec/cook.c

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2012-10-27 15:02:35 +02:00
Diego Biurrun 13bbefd57e doxygen: Add av_alloc_size to list of predefined macros
This avoids Doxygen believing the attribute is the function name.
2012-10-26 18:28:38 +02:00
Diego Biurrun 74e742d6ad doxygen: Drop some pointless entries from PREDEFINED macros list 2012-10-26 18:28:38 +02:00
Stefano Sabatini a161def1e4 Doxyfile: update examples path and patterns 2012-10-24 23:40:15 +02:00
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>
2012-10-24 17:14:50 +02:00
Michael Niedermayer 719fde47ca Merge commit 'c68317ebbe4915035df0b08c23eea7a0b80ab881'
* commit 'c68317ebbe4915035df0b08c23eea7a0b80ab881':
  lavc: fix documentation for AVCodecContext.delay
  atrac3: return an error if extradata_size is not a specific known size
  lavc: use the correct API version guard macro for avcodec_encode_audio()
  Move Doxyfile into the doc/ subdirectory
  doxygen: Build Doxygen documentation in the doc/ subdirectory
  dfa: use av_memcpy_backptr() where previously impossible
  av_memcpy_backptr: Drop no longer necessary malloc padding

Conflicts:
	.gitignore
	libavcodec/avcodec.h

Merged-by: Michael Niedermayer <michaelni@gmx.at>
2012-10-24 14:18:17 +02:00
Diego Biurrun 5e28e97433 Move Doxyfile into the doc/ subdirectory 2012-10-23 20:25:41 +02:00