Copy Page

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account. You can also Sign Up for a new account.

<h2><code>&lt;groovydoc&gt;</code></h2><h3>Description</h3><p>Generates documentation from Groovy and Java source files.</p><h3>Required taskdef</h3><p>Assuming groovy-all-VERSION.jar is in <em>my.classpath</em> you will need to declare this task at some point in the build.xml prior to the groovydoc task being invoked.</p><table class="wysiwyg-macro" data-macro-name="code" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGV9&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>&lt;taskdef name         = "groovydoc"
         classname    = "org.codehaus.groovy.ant.Groovydoc"
         classpathref = "my.classpath"/>
</pre></td></tr></table><h3>&lt;groovydoc&gt; Attributes</h3><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Attribute</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th></tr><tr><td class="confluenceTd"><p>destdir</p></td><td class="confluenceTd"><p>Location to store the class files.</p></td><td class="confluenceTd"><p>Yes</p></td></tr><tr><td class="confluenceTd"><p>sourcepath</p></td><td class="confluenceTd"><p>The sourcepath to use.</p></td><td class="confluenceTd"><p>No</p></td></tr><tr><td class="confluenceTd"><p>packagenames</p></td><td class="confluenceTd"><p>Comma separated list of package files (with terminating wildcard).</p></td><td class="confluenceTd"><p>No</p></td></tr><tr><td class="confluenceTd"><p>use</p></td><td class="confluenceTd"><p>Create class and package usage pages.</p></td><td class="confluenceTd"><p>No</p></td></tr><tr><td class="confluenceTd"><p>windowtitle</p></td><td class="confluenceTd"><p>Browser window title for the documentation (text).</p></td><td class="confluenceTd"><p>No</p></td></tr><tr><td class="confluenceTd"><p>doctitle</p></td><td class="confluenceTd"><p>Include title for the package index(first) page (html-code).</p></td><td class="confluenceTd"><p>No</p></td></tr><tr><td class="confluenceTd"><p>header</p></td><td class="confluenceTd"><p>Include header text for each page (html-code).</p></td><td class="confluenceTd"><p>No</p></td></tr><tr><td class="confluenceTd"><p>footer</p></td><td class="confluenceTd"><p>Include footer text for each page (html-code).</p></td><td class="confluenceTd"><p>No</p></td></tr><tr><td class="confluenceTd"><p>overview</p></td><td class="confluenceTd"><p>Read overview documentation from HTML file.</p></td><td class="confluenceTd"><p>No</p></td></tr><tr><td class="confluenceTd"><p>private</p></td><td class="confluenceTd"><p>Show all classes and members (i.e. including private ones) if set to &quot;true&quot;.</p></td><td class="confluenceTd"><p>No</p></td></tr></tbody></table><h3>&lt;groovydoc&gt; Nested Elements</h3><h4>link</h4><p>Create link to groovydoc/javadoc output at the given URL.</p><table class="confluenceTable"><tbody><tr><th class="confluenceTh"><p>Attribute</p></th><th class="confluenceTh"><p>Description</p></th><th class="confluenceTh"><p>Required</p></th></tr><tr><td class="confluenceTd"><p>packages</p></td><td class="confluenceTd"><p>Comma separated list of package prefixes</p></td><td class="confluenceTd"><p>Yes</p></td></tr><tr><td class="confluenceTd"><p>href</p></td><td class="confluenceTd"><p>Base URL of external site</p></td><td class="confluenceTd"><p>Yes</p></td></tr></tbody></table><h3>Example #1 - &lt;groovydoc&gt; Ant task</h3><table class="wysiwyg-macro" data-macro-name="code" data-macro-default-parameter="xml" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6eG1sfQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>&lt;taskdef name           = "groovydoc"
         classname      = "org.codehaus.groovy.ant.Groovydoc"
         classpathref   = "path_to_groovy_all"/>

&lt;groovydoc destdir      = "${docsDirectory}/gapi"
           sourcepath   = "${mainSourceDirectory}"
           packagenames = "**.*"
           use          = "true"
           windowtitle  = "${title}"
           doctitle     = "${title}"
           header       = "${title}"
           footer       = "${docFooter}"
           overview     = "src/main/overview.html"
           private      = "false">
        &lt;link packages="java.,org.xml.,javax.,org.xml." href="http://download.oracle.com/javase/6/docs/api"/>
        &lt;link packages="org.apache.tools.ant."          href="http://evgeny-goldin.org/javadoc/ant/api"/>
        &lt;link packages="org.junit.,junit.framework."    href="http://kentbeck.github.com/junit/javadoc/latest"/>
        &lt;link packages="groovy.,org.codehaus.groovy."   href="http://groovy.codehaus.org/api/"/>
        &lt;link packages="org.codehaus.gmaven."           href="http://evgeny-goldin.org/javadoc/gmaven"/>
&lt;/groovydoc>
</pre></td></tr></table><h3>Example #2 - Executing &lt;groovydoc&gt; from Groovy</h3><table class="wysiwyg-macro" data-macro-name="code" data-macro-default-parameter="xml" style="background-image: url(/plugins/servlet/confluence/placeholder/macro-heading?definition=e2NvZGU6eG1sfQ&amp;locale=en_GB&amp;version=2); background-repeat: no-repeat;" data-macro-body-type="PLAIN_TEXT"><tr><td class="wysiwyg-macro-body"><pre>def ant = new AntBuilder()
ant.taskdef(name: "groovydoc", classname: "org.codehaus.groovy.ant.Groovydoc")
ant.groovydoc(
    destdir      : "${docsDirectory}/gapi",
    sourcepath   : "${mainSourceDirectory}",
    packagenames : "**.*",
    use          : "true",
    windowtitle  : "${title}",
    doctitle     : "${title}",
    header       : "${title}",
    footer       : "${docFooter}",
    overview     : "src/main/overview.html",
    private      : "false") {
        link(packages:"java.,org.xml.,javax.,org.xml.",href:"http://download.oracle.com/javase/6/docs/api")
        link(packages:"groovy.,org.codehaus.groovy.",  href:"http://groovy.codehaus.org/api")
        link(packages:"org.apache.tools.ant.",         href:"http://evgeny-goldin.org/javadoc/ant/api")
        link(packages:"org.junit.,junit.framework.",   href:"http://kentbeck.github.com/junit/javadoc/latest")
        link(packages:"org.codehaus.gmaven.",          href:"http://evgeny-goldin.org/javadoc/gmaven")
}
</pre></td></tr></table>