diff options
| author | Michael Niedermayer <michaelni@gmx.at> | 2011-12-06 01:37:27 +0100 |
|---|---|---|
| committer | Michael Niedermayer <michaelni@gmx.at> | 2011-12-06 01:37:27 +0100 |
| commit | b404ab9e74d3bca12d5989c366f5cfd746279067 (patch) | |
| tree | fdbba6fdf7a4694fe7b7ecda6401ea6a2e01f95e /doc/developer.texi | |
| parent | a448a5d1c4620aa58ec138fbffd46d18d42d53e0 (diff) | |
| parent | 52401b82bd2ed30d4c4353cb084bf4ee679d0c22 (diff) | |
| download | ffmpeg-b404ab9e74d3bca12d5989c366f5cfd746279067.tar.gz | |
Merge remote-tracking branch 'qatar/master'
* qatar/master:
mov: Don't av_malloc(0).
avconv: only allocate 1 AVFrame per input stream
avconv: fix memleaks due to not freeing the AVFrame for audio
h264-fate: remove -strict 1 except where necessary (mr4/5-tandberg).
misc Doxygen markup improvements
doxygen: eliminate Qt-style doxygen syntax
g722: Add a regression test for muxing/demuxing in wav
g722: Change bits per sample to 4
g722dec: Signal skipping the lower bits via AVOptions instead of bits_per_coded_sample
api-example: update to use avcodec_decode_audio4()
avplay: use avcodec_decode_audio4()
avplay: use a separate buffer for playing silence
avformat: use avcodec_decode_audio4() in avformat_find_stream_info()
avconv: use avcodec_decode_audio4() instead of avcodec_decode_audio3()
mov: Allow empty stts atom.
doc: document preferred Doxygen syntax and make patcheck detect it
Conflicts:
avconv.c
ffplay.c
libavcodec/mlpdec.c
libavcodec/version.h
libavformat/mov.c
tests/codec-regression.sh
tests/fate/h264.mak
Merged-by: Michael Niedermayer <michaelni@gmx.at>
Diffstat (limited to 'doc/developer.texi')
| -rw-r--r-- | doc/developer.texi | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/developer.texi b/doc/developer.texi index 2d3d418b97..75895d9147 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -77,6 +77,11 @@ Use the JavaDoc/Doxygen format (see examples below) so that code documentation can be generated automatically. All nontrivial functions should have a comment above them explaining what the function does, even if it is just one sentence. All structures and their member variables should be documented, too. + +Avoid Qt-style and similar Doxygen syntax with @code{!} in it, i.e. replace +@code{//!} with @code{///} and similar. Also @@ syntax should be employed +for markup commands, i.e. use @code{@@param} and not @code{\param}. + @example /** * @@file |