Hi,
Interesting result... but this is "documenting" at the lowest level,
meaning adding comments to the code itself. That's essential too,
although it assumes the code itself being structured well!
The main issue to discuss then, is what people think of adding a tool
(doxygen) to interpret c files. Opinions please!
-Ton-
On Friday, Apr 25, 2003, at 02:48 Europe/Amsterdam, Casey Corn wrote:
Hi all!
As promised, here is an example of the doxygen system,
and the methods I propose to use.
I looked into the way GHOST was documented (thank you
Laurence Bourn :) and I tried to pattern what I did
off of that. Since GHOST is mostly c++, I made some
changes here and there.
I created a directory called "doxygen" in the
bf-blender directory (same level as blender, libs, and
old directories) and put the doxygen config file in
here (this file could also go in the blender/doc
directory). This is also where doxygen creates the
html directory and files. The config file I used is:
http://stu.aii.edu/~cmc271/blender/doxygen/Doxyfile
The GHOST project uses a file called ghost_doxygen.in,
presumably to customize the Doxyfile configuration
file to enable certain doxygen features. We may want
to look into doing the same thing.
I documented the file source/creator/creator.c since I
had already studied it and new mostly what was
happening. The commented file is:
http://stu.aii.edu/~cmc271/blender/creator.c
After running "doxygen" in the doxygen directory, the
output is placed in an appropriate directory: html for
html docs, latex for latex docs, rtf for rtf docs,
well you get the idea :). The output generated is:
http://stu.aii.edu/~cmc271/blender/doxygen/html/
Please let me know what you think!
Thanks,
Casey
__________________________________________________
Do you Yahoo!?
The New Yahoo! Search - Faster. Easier. Bingo
http://search.yahoo.com
_______________________________________________
Bf-committers mailing list
Bf-committers@xxxxxxxxxxx
http://www.blender.org/mailman/listinfo/bf-committers
------------------------------------------------------------------------
--
Ton Roosendaal Blender Foundation ton@xxxxxxxxxxx
