[JIRA] Updated: (CC-202) generate configxml.html automatically

     [ http://jira.public.thoughtworks.org/browse/CC-202?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Seth Pollen updated CC-202:
---------------------------

    Attachment: patch-v2.7.diff

Attached: patch-v2.7.diff

In the attached patch:
1. I have added some tests for the gendoc-related JMX methods.

2. I have incorporated gendoc annotations into the following plugin classes (as examples): 
    ConfigurationPlugin <configuration>
    SystemPlugin <system>
    ThreadsPlugin <threads>
    CruiseControlConfig <cruisecontrol>
    ProjectConfig <project>

3. I have expanded the section in plugins.html that discusses gendoc. This now includes a summary of "best practices" for incorporating annotations into the codebase, as well as links to the source files that have already had annotations added.

4. I have made some other code changes here and there to clean up the gendoc code.

Please let me know if I have missed anything, and I will probably post something on the dev list about the PluginDetail/PluginInfo mind-meld sometime soon.

- Seth Pollen

> generate configxml.html automatically
> -------------------------------------
>
>                 Key: CC-202
>                 URL: http://jira.public.thoughtworks.org/browse/CC-202
>             Project: CruiseControl
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 2.2.1
>            Reporter: Jerome Lacoste
>         Assigned To: Dan Rollo
>            Priority: Trivial
>         Attachments: CC-202-part2-v1.diff, configxml.html, configxml.html, configxml.html, configxml.html, Gendoc Design Proposal v2.0.pdf, net.sourceforge.cruisecontrol.ProjectConfig.xml, patch-v2.0.diff, patch-v2.1.diff, patch-v2.2.diff, patch-v2.3.diff, patch-v2.4.diff, patch-v2.5.diff, patch-v2.6.diff, patch-v2.7.diff, patch-v6-part1.diff, patch-v6-part2.diff, patch_before_cleanup_and_full_conversion.diff, patch_v3.diff, patch_v4.diff, patch_v5.diff, proof-of-concept-diff.log, proof-of-concept-diff.txt, proof-of-concept-diff.txt
>
>
> Several people have expressed their desire of having such feature.
> xdoclet sounds like a good candidate for this problem. If addressed that way, this issue can be broken down in several steps:
> - identify the documentation requirements
> - create a tag specification that would allow to solve these requirements. 
>   We might lose some features as we will perhaps not be able to be as flexible as with the manual documentation
> - write the xdoclet tags that help to generate the intermediate XML
> - create an XSL template that generates the HTML from the intermediate XML
> - move the current configxml.html into tags inside the code
> - update the build/release process to generate the documentation

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.public.thoughtworks.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

------------------------------------------------------------------------------
Nokia and AT&T present the 2010 Calling All Innovators-North America contest
Create new apps & games for the Nokia N8 for consumers in  U.S. and Canada
$10 million total in prizes - $4M cash, 500 devices, nearly $6M in marketing
Develop with Nokia Qt SDK, Web Runtime, or Java and Publish to Ovi Store 
http://p.sf.net/sfu/nokia-dev2dev