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

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

Dan Rollo commented on CC-202:
------------------------------

Urgh, seeing another type of test failure:


    [junit] ------------- Standard Output ---------------
    [junit] Error - Cannot have @Description and @DescriptionFile on the same element.
    [junit] Error - Cannot have @Examples and @ExamplesFile on the same element.
    [junit] Error while parsing attribute 'public abstract void net.sourceforge.cruisecontrol.gendoc.testplugins.BadRoot.setData(java.lang.Object)' - Attribute setter method of plugin class must accept a boolean, String, or numeric type
    [junit] Error while parsing attribute 'public abstract void net.sourceforge.cruisecontrol.gendoc.testplugins.BadRoot.setData(java.lang.StringBuilder)' - Attribute setter method of plugin class must accept a boolean, String, or numeric type
    [junit] Error while parsing attribute 'public abstract void net.sourceforge.cruisecontrol.gendoc.testplugins.BadRoot.setBadCardinality(int)' - Maximum cardinality must be 1 for attributes.
    [junit] Error while parsing attribute 'public abstract void net.sourceforge.cruisecontrol.gendoc.testplugins.BadRoot.setTooManyAnnotations(int)' - Cannot have @Required and @Optional annotations on the same attribute method
    [junit] Error while parsing attribute 'public abstract void net.sourceforge.cruisecontrol.gendoc.testplugins.BadRoot.setTooManyDescriptions(java.lang.String)' - Cannot have @Description and @DescriptionFile on the same element.
    [junit] Error while parsing attribute 'public abstract void net.sourceforge.cruisecontrol.gendoc.testplugins.BadRoot.setInvalidDescription(java.lang.String)' - Invalid XML content in description: The element type "i" must be terminated by the matching end-tag "</i>".
    [junit] Error while parsing attribute 'public abstract void net.sourceforge.cruisecontrol.gendoc.testplugins.BadRoot.setInvalidNote(java.lang.String)' - Invalid XML content in cardinality: The element type "blah" must be terminated by the matching end-tag "</blah>".
    [junit] Error while parsing child method 'public abstract net.sourceforge.cruisecontrol.gendoc.testplugins.GoodChild net.sourceforge.cruisecontrol.gendoc.testplugins.BadRoot.createMoreBadCardinality()' - Minimum cardinality cannot be negative.
    [junit] Error while parsing child method 'public abstract net.sourceforge.cruisecontrol.gendoc.testplugins.GoodChild net.sourceforge.cruisecontrol.gendoc.testplugins.BadRoot.createEvenMoreBadCardinality()' - Maximum cardinality may not be less than minimum cardinality.
    [junit] Error while parsing child method 'public abstract void net.sourceforge.cruisecontrol.gendoc.testplugins.BadRoot.createBar()' - Child create method of plugin class must have a non-void return type
    [junit] Error while parsing child method 'public abstract void net.sourceforge.cruisecontrol.gendoc.testplugins.BadRoot.addBar()' - Child add method of plugin class must have exactly one parameter
    [junit] Error while parsing child method 'public abstract void net.sourceforge.cruisecontrol.gendoc.testplugins.BadRoot.addImpossibleChild(java.lang.String)' - Child method does not accept any valid node classes.
    [junit] ------------- ---------------- ---------------
    [junit] Testcase: testRootFields(net.sourceforge.cruisecontrol.gendoc.PluginInfoTest):	FAILED
    [junit] null expected:<XXX[]> but was:<XXX[
    [junit] ]>
    [junit] junit.framework.ComparisonFailure: null expected:<XXX[]> but was:<XXX[
    [junit] ]>
    [junit] 	at net.sourceforge.cruisecontrol.gendoc.PluginInfoTest.testRootFields(PluginInfoTest.java:74)
    [junit] 
    [junit] 

BUILD FAILED
/home/dan/devtools/cc-new/cruisecontrol/build.xml:35: The following error occurred while executing this line:
/home/dan/devtools/cc-new/cruisecontrol/.ant-scripts/build-test.xml:82: Tests failed




> 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-v2.8.diff, patch-v2.9-output.txt, patch-v2.9.diff, patch-v2.9b.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

        

------------------------------------------------------------------------------
The modern datacenter depends on network connectivity to access resources
and provide services. The best practices for maximizing a physical server's
connectivity to a physical network are well understood - see how these
rules translate into the virtual world? 
http://p.sf.net/sfu/oracle-sfdevnlfb