[Bf-committers] Doxygen project

Casey Corn bf-committers@blender.org
Mon, 9 Jun 2003 10:14:12 -0700 (PDT)

Hi all,
--- Ton Roosendaal <ton@blender.org> wrote:
> Hi,
> (changed the subject to attract more attention!)
> Everyone, please give feedback on doxy strategies...
> it's nice to say "go ahead" but it really involves
> some more thinking... it especially should give a
> result that's actually *used* by people. Since I'm
> not the typical representative for a coder here, I
> need you to help casey with doing the right stuff.

Yes please!  I'm in the dark, especially when it comes
to "the right stuff" ;) .  What do you all need to
> Right now, my opinion is simple:
> - doxify the classes/headers and external API only
> - no doxy comments inside the code, but restrict to
> .h files
> - only document what would give additional added
> value.
> - Code readability and layout should never be
> sacrified
> -Ton-

I have no problem with this, or with what Nathan
wrote, except for one thing: source/blender/src . 
This is where I personally have the most difficult
time understanding the code (am I the only one?). 
This also appears to be the core of blender, with
mesh/curve manipulations, gui stuff, texturing, etc. 
The other source/blender directories appear to be
fairly well seperated into modules.  Also, only one of
the 80 or so files is a .h file.

While I don't plan on documenting src soon (nor do I
know of anyone else who is going to ;) ), I don't
think it's too early to talk about it.

Thanks for the feedback,

Do you Yahoo!?
Yahoo! Calendar - Free online calendar with sync to Outlook(TM).