Lines of Code

Developers

Most Recent Commits

jez 2007-04-04 18:46

groovydoc

* added default constructors

* added java constructors

* fixed font for all classes in top frame

26 lines of code changed in:

• groovy/groovy-core/src/main/org/codehaus/groovy/tools/groovydoc: GroovyRootDocBuilder.java (+9 -2), SimpleGroovyClassDocAssembler.java (+17 -1)

jez 2007-04-03 19:32

groovydoc

* added constructor documentation for groovy source (but not java yet).

* main page now has alphabetically sorted list of classes.

* refactored SimpleGroovyClassDocAssembler to avoid duplication of parameter handling

* moved "Generating..." message slightly earlier in the proceedings, so the template rendering is included.

92 lines of code changed in:

• groovy/groovy-core/src/main/org/codehaus/groovy/tools/groovydoc: GroovyDocWriter.java (+2 -2), SimpleGroovyClassDoc.java (+14 -2), SimpleGroovyClassDocAssembler.java (+44 -16), SimpleGroovyConstructorDoc.java (new 26), SimpleGroovyRootDoc.java (+6 -1)

paulk 2007-03-31 03:47

GroovyDoc tweaks

11 lines of code changed in:

• groovy/groovy-core/src/main/org/codehaus/groovy/tools/groovydoc: GroovyDocTemplateEngine.java (+1 -1), GroovyDocTool.java (+3 -10), GroovyDocWriter.java (+7 -5)

paulk 2007-03-31 01:51

GroovyDoc tweaks

3 lines of code changed in:

• groovy/groovy-core/src/main/org/codehaus/groovy/tools/groovydoc: FileOutputTool.java (+3 -1)

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.

1492 lines of code changed in:

• groovy/groovy-core/src/main/org/codehaus/groovy/tools/groovydoc: ClasspathResourceManager.java (new 40), FileOutputTool.java (new 32), FileSystemResourceManager.java (new 37), GroovyDocTemplateEngine.java (new 170), GroovyDocTool.java (new 75), GroovyDocWriter.java (new 101), GroovyRootDocBuilder.java (new 162), MockOutputTool.java (new 53), OutputTool.java (new 23), ResourceManager.java (new 25), SimpleGroovyClassDoc.java (new 119), SimpleGroovyClassDocAssembler.java (new 197), SimpleGroovyDoc.java (new 78), SimpleGroovyExecutableMemberDoc.java (new 50), SimpleGroovyFieldDoc.java (new 31), SimpleGroovyMemberDoc.java (new 26), SimpleGroovyMethodDoc.java (new 38), SimpleGroovyPackageDoc.java (new 48), SimpleGroovyParameter.java (new 41), SimpleGroovyProgramElementDoc.java (new 39), SimpleGroovyRootDoc.java (new 70), SimpleGroovyType.java (new 37)