[Bf-python] Automatic documentation : ) !

[Willian Padovani Germano]

On Wed, 2003-06-18 at 21:59, Ramanan Selvaratnam wrote:
> Thanks. Now what we need to ascertain is whether there is someone 
> already  on the case.
> I noticed sometime back there was mention of Python documentation on the 
> [bf-docboard].
>  
> If there is someone  working on it I will like to join in.
> Otherwise  I can do an outline to fit a model as described above and see 
> where we go from there.

Well, each developer is free to prepare docs for their "own" (;))
modules or let someone else do it.  If you'd like to participate, great
: ), you could email me and discuss what you want to do or do it in this
list.  For example, the Draw and BGL modules need more care and, for
those, there is documentation at the recently freed Blender Manual
sources.  So we can look there for material.  Same for other modules.

> >Doxygen will be used to write the documents intended for developers who
> >want to implement new features in the Python API. 
> >
> A sort of an apendix  to the forthcoming blender manual, I guess (?)

Probably not, Doxygen is for developers, it generates a stand-alone doc
about the source code itself.  And once many files are commented for
Doxygen, this doc will be huge.

--
Willian, wgermano at ig.com.br