Lines of Code

Developers

Most Recent Commits

jez 2007-03-30 23:21

Added initial implementation of Groovydoc



Java and Groovy files are read into a tree of value objects from GroovyDoclet API ( org.codehaus.groovy.groovydoc.* )

This tree is then used to generate root, package and class level template renderings

using the GStringTemplateEngine.



The default templates are included within the base groovy jar, so groovydoc can be used 'fresh out of the box'



use from ant:

<taskdef name="groovydoc" classname="org.codehaus.groovy.ant.Groovydoc">

<groovydoc sourcepath="${src.dir}"

destdir="${groovydoc.dir}"

packagenames="${groovydoc.packages}"

use="true"

windowtitle="groovydoc"

private="true"/>





I hope people will enjoy these classes, and I invite you to come and put some flesh onto this skeleton implementation.



Limitations:

- class html files only lists method summaries so far

- comments are not treated properly yet

- groovydoc ant task has only very basic parameters so far



Cheers



Jez.

120 lines of code changed in:

• groovy/groovy-core/src/main/org/codehaus/groovy/tools/groovydoc/gstring-templates/package-level: package-frame.html (new 46), package-summary.html (new 68), packageDocStructuredData.xml (new 6)