The groovydoc Ant task Add comment to Wiki View in Wiki Edit Wiki page Printable Version

<groovydoc>

Description

Generates documentation from Groovy and Java source files.

Required taskdef

Assuming groovy-all-VERSION.jar is in my.classpath you will need to declare this task at some point in the build.xml prior to the groovydoc task being invoked.

<groovydoc> Attributes

Attribute

Description

Required

destdir

Location to store the class files.

Yes

sourcepath

The sourcepath to use.

No

packagenames

Comma separated list of package files (with terminating wildcard).

No

use

Create class and package usage pages.

No

windowtitle

Browser window title for the documentation (text).

No

doctitle

Include title for the package index(first) page (html-code).

No

header

Include header text for each page (html-code).

No

footer

Include footer text for each page (html-code).

No

overview

Read overview documentation from HTML file.

No

private

Show all classes and members (i.e. including private ones) if set to "true".

No

<groovydoc> Nested Elements

Create link to groovydoc/javadoc output at the given URL.

Attribute

Description

Required

packages

Comma separated list of package prefixes

Yes

href

Base URL of external site

Yes

Example #1 - <groovydoc> Ant task

Example #2 - Executing <groovydoc> from Groovy

 

Search

Results of your search request can come from various sources: the Groovy website itself, the JIRA issues, the API documentation, as well as a few other interesting Groovy-related blogs.

  By  -  pages  -  views  - last modified