[Task #65409] Add autodocumenting tof cents

Task #65409 has been updated. 

Project: Krysalis Community Project
Subproject: centipede
Summary: Add autodocumenting tof cents
Complete: 55%
Status: Deleted
Authority  : rgardler
Assigned to: rgardler

Description: It should be possible to automatically generate the documentation of cents from the xbuild file (with some additions of @javadoc style comments).



See discussion on the dev mailing list Nov 2002 (subject Docuementing cents (intentially spelling mistak)

Follow-Ups:

-------------------------------------------------------
Date: 2004-03-04 02:27
By: rgardler

Comment:
Since I have done nothing on this for some time and "centipde2" is near Beta I am deleting this task to get it off my SF home page.

-------------------------------------------------------
Date: 2002-12-27 13:54
By: rgardler

Comment:
Separates main, helper and internal targets into different pages.

-------------------------------------------------------
Date: 2002-12-24 01:53
By: rgardler

Comment:
------

ToDo

-------

Rather than taking infor from module.xml firectly, include this in centdoc.xml



identify helper targets in centdoc.xml (those without description comments)



Create separate pages for helper and internal targets (main should remain on index page)



Create a page that lists all properties regardless of where they are used



Add xbuild.xml and legal pages

-------

DONE

-------

Documentation generation for poperties

Overview list

-------------------------------------------------------
Date: 2002-12-17 23:24
By: rgardler

Comment:
Chunking is now removed.



Overview page structure in place, cannot add descriptions until all cents have module.xml



Properties now display in tables rather than sections.





-------------------------------------------------------
Date: 2002-12-16 17:30
By: rgardler

Comment:


Properties

----------



At the moment the properties and default value is extracted from xbuild.xml, Nick and I thought it would be good to also have some form of description for each property in the xbuild.xml file itself. This is provided by a preceeding comment:





<!-- How many bars to use-->

<property name="foo.cent.bar.param">123</property>



Chunking

--------



Currently the docs are chunked across introductory material and individual targets. I personally feel that this causes too many clicks to get to the info I want. I seem to remember somebody else commenting on this after Beta3 was released.



I propose making all cent docs appear on a single page and relying on the new menu generation to give indexed access to the page. Any objections?



Overview Page

-------------



I propose changing the index page of the cents site to an overview page with a short description of each cent and a link to the detail page.



Property Info

-------------



Having each property as a separate section is cluttering up the menu on the left. I propose putting all the properties in a table, this will lose indexing to individual properties, but looking through the existing cents I can't see any that have so many properties we really need to index them, in most cases they will all fit on a single screen.



"private" targets

-----------------

If a target has a '-' in it assume that it is "private", that is, it is not intended to be called directly by the user. These cents will be clearly marked as such and displayed in a separate section. Dependencies of targets on others will appear as links to the dependant targets. 



Additional Info

----------------



For all cents  it would be nice to have



   * xbuild.xml source.

   * legal / licenese information.





Some cents (forrest for example)  will be owned by other groups.

Also users may cant to build local copies of the cent docs for use in their sites.



To support this I think we should add for each cent.



   * optional link to cent homepage.

   * copyright information. 



This information is already in proejct-info.xml and each cent *may* be getting its own project-info.xml file. Use it from there is it does.

-------------------------------------------------------
For more info, visit:

http://sourceforge.net/pm/task.php?func=detailtask&project_task_id=65409&group_id=36516&group_project_id=16959


-------------------------------------------------------
This SF.Net email is sponsored by: IBM Linux Tutorials
Free Linux tutorial presented by Daniel Robbins, President and CEO of
GenToo technologies. Learn everything from fundamentals to system
administration.http://ads.osdn.com/?ad_id=1470&alloc_id=3638&op=click