1 May 2005 01:20
[PATCH] Changing FF_COMMON_FRAME to an include file
Josh Varner <jlvarner <at> gmail.com>
2005-04-30 23:20:36 GMT
2005-04-30 23:20:36 GMT
I've noticed that the documentation for AVFrame does not get processed by doxygen correctly, since it's defined as a #define which are not macro expanded by doxygen with the current Doxyfile included with ffmpeg. The current documentation at http://www.mplayerhq.hu/~michael/ffmpeg-doxy/structAVFrame.html gives you the impression that it is an empty data structure, and even if you know that FF_COMMON_FRAME contains most of the data the doxygen documentation for FF_COMMON_FRAME shows nothing as well http://www.mplayerhq.hu/~michael/ffmpeg-doxy/avcodec_8h.html#a78. By changing this define into an include file the documentation will be generated correctly by doxygen. I've tested this on my machine, unfortunatly I don't have someplace to post the results, but I got the expected results as doxygen does all of the including during its processing, and the new include file does not have the backslashes at the end of every line to throw off doxygen's processing. I think this will greatly improve the readability of the documentation without any functional changes. Josh P.S I ran the tests and got a failure at this point, but since it passed several pages of tests I doubt this had anything do to with my changes: ffmpeg version 0.4.9-pre1, build 4753, Copyright (c) 2000-2004 Fabrice Bellard configuration: built on Apr 30 2005 16:41:13, gcc: 3.4.2 20041017 (Red Hat 3.4.2-6.fc3) ../ffmpeg_g -y -bitexact -dct_algo 1 -idct_algo 2 -i ./data/b-libav.nut -f crc ./data/ffmpeg.crc /home/josh/projects/ffmpeg/doc/tests/regression.sh: line 125: 21138(Continue reading)
RSS Feed