Re: [Dynapi-Dev] Object / Widget documentation

[Leif W <war...@us...>]

Think this sounds like a good idea.  As a milestone marker, we could keep a
percentage of documentation completed on the main page.  Could have some
color code, red - no docs, yellow, partially documented, green, fully
documented.  Could have something like a treview of the API, showing each
node in the color based on it's children.  You look at the top node (it's
yellow most of the time), so you know something somewhere needs to be
documented.  Expanding the node, you see one (or more) nodes in green and
yellow or red states.  Expanding a yellow node, you find a list of items all
green except one item is yellow, so you finish documenting that and make it
green, then its parent becomes green, and you have done some work.  :-)

Leif

----- Original Message ----- 
From: "Daniel Tiru" <de...@ti...>
To: <dyn...@li...>
Sent: Friday, October 24, 2003 8:48 AM
Subject: [Dynapi-Dev] Object / Widget documentation


> Hi!
>
> I was thinking of a way to keep the widget and object documentation up
> to date better, that is that I could set up a database and make a
> webadmin to that so we could update the docs smoothly and have a better
> overview of what objects/widgets that needs to be documented, and what
> is missing and so on.
>
> Then for release we just make html of all the info stored in the db and
> add it to cvs. What do you all think of this?
>
> What type of data we need (fill in on this)
> Object Name or Widget Name
> Constructor with comments
> Properties with comments
> Functions with comments
> Private/public Methods with comments
> Examples
>
> We could also make a comment to each file so we all know what that file
> does.
>
> What do you think?
>
> Regards
> Daniel
>
>
>
>
> -------------------------------------------------------
> This SF.net email is sponsored by: The SF.net Donation Program.
> Do you like what SourceForge.net is doing for the Open
> Source Community?  Make a contribution, and help us add new
> features and functionality. Click here: http://sourceforge.net/donate/
> _______________________________________________
> Dynapi-Dev mailing list
> Dyn...@li...
> http://www.mail-archive.com/dyn...@li.../
>
>