[Bf-committers] Doxygen docs?

[Yann Vernier]

On Wed, Jan 05, 2005 at 12:44:04PM -0800, joeedh wrote:
> Hi, I'd be interesting in writing code comments for parts of Blender's 
> source code.  I have a fairly good understanding of it, and whoever was 
> previously doing this seems to have given up.  I've gotten Doxygen to 
> work, and I've found the main doxygen configuration/source files in doc/.
> 
> Of course this would involve me mailing patches fairly often.  Also it 
> would be nice to have the doxygen file header before the GPL block, but 
> this doesn't seem to be necassary (just tested it).

I for one would certainly appreciate it! Most of the blender coding I do
is inspecting and correcting code, and it is really useful then to know
little details like if a pointer passed to a function may be NULL or
will have its data copied. For that matter, my most recent question was
whether guardedalloc's MEM_freeN truly frees the memory for use or not,
and while that might be obvious to some people from its source it is not
to me. Related indexes like what functions operate on ListBase
structures would also be good. 

These are just things I have hit recently, and there might be some
documentation out there I have missed, but I hope you get the idea.
Things like "addlisttolist" moving the second list to the first
destructively are not necessarily obvious.