de.unkrig.doclet.ant

Class AntDoclet

java.lang.Object

de.unkrig.doclet.ant.AntDoclet

public class AntDoclet
extends Object

A doclet that generates documentation for APACHE ANT tasks and other artifacts.

See Also:

"Doclet Overview"

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AntDoclet.AntAttribute Representation of an attribute of an ANT type.
static class	AntDoclet.AntSubelement Representation of a subelement of an ANT type (described in the ANT documentation as "Parameters specified as nested elements").
static class	AntDoclet.AntType Representation of an "ANT type", see Concepts and Types.
static class	AntDoclet.AntTypeGroup Representation of a "group of types", e.g.

Constructor Summary

Constructors

Constructor and Description
AntDoclet(com.sun.javadoc.RootDoc rootDoc, de.unkrig.notemplate.javadocish.Options options, Collection<String> antlibResources, Collection<File> antlibFiles, Map<String,URL> externalJavadocs, de.unkrig.doclet.ant.AntDoclet.Theme theme, String[] sourcePath)

Method Summary

Modifier and Type	Method and Description
static List<AntDoclet.AntAttribute>	attributesOf(com.sun.javadoc.ClassDoc classDoc, com.sun.javadoc.RootDoc rootDoc)
static com.sun.javadoc.MethodDoc	characterDataOf(com.sun.javadoc.ClassDoc classDoc)
static com.sun.javadoc.LanguageVersion	languageVersion()
static int	optionLength(String option) See "Doclet Overview".
static boolean	start(com.sun.javadoc.RootDoc rootDoc) A doclet that generates documentation for APACHE ANT tasks and other artifacts.
static List<AntDoclet.AntSubelement>	subelementsOf(com.sun.javadoc.ClassDoc classDoc, com.sun.javadoc.RootDoc rootDoc)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AntDoclet

public AntDoclet(com.sun.javadoc.RootDoc rootDoc,
                 de.unkrig.notemplate.javadocish.Options options,
                 Collection<String> antlibResources,
                 Collection<File> antlibFiles,
                 Map<String,URL> externalJavadocs,
                 de.unkrig.doclet.ant.AntDoclet.Theme theme,
                 @Nullable
                 String[] sourcePath)
          throws IOException

Throws:

IOException

Method Detail

languageVersion

public static com.sun.javadoc.LanguageVersion languageVersion()

optionLength

public static int optionLength(String option)

See "Doclet Overview".

start

public static boolean start(com.sun.javadoc.RootDoc rootDoc)
                     throws IOException,
                            ParserConfigurationException,
                            SAXException,
                            TransformerException

A doclet that generates documentation for APACHE ANT tasks and other artifacts.

Opens, reads and parses an ANTLIB file and generates one document per type, task, macro, preset and script defined therein.

Supports the following command line options:

-antlib-file file

Source of task names an class names (mandatory).

-html-output-directory dir

Where to create documentation in HTML format (optional).

-mediawiki-output-directory dir

Where to create documentation in MEDIAWIKI markup format (optional).

-link target-url

-linkoffline target-url package-list-url

See here.

-doctitle text

See here.

-windowtitle text

See here.

-theme JAVA7|JAVA8

Which style sheets and resources to use.

-splitindex

Splits the index file into multiple files, alphabetically, one file per letter, plus a file for any index entries that start with non-alphabetical characters.

-charset name

Specifies the HTML character set for this document.

-docencoding name

Specifies the encoding of the generated HTML files.

Throws:

IOException

ParserConfigurationException

SAXException

TransformerException

characterDataOf

@Nullable
public static com.sun.javadoc.MethodDoc characterDataOf(com.sun.javadoc.ClassDoc classDoc)

Returns:

The MethodDoc of the "addText(String)", or null

attributesOf

public static List<AntDoclet.AntAttribute> attributesOf(com.sun.javadoc.ClassDoc classDoc,
                                                        com.sun.javadoc.RootDoc rootDoc)

subelementsOf

public static List<AntDoclet.AntSubelement> subelementsOf(com.sun.javadoc.ClassDoc classDoc,
                                                          com.sun.javadoc.RootDoc rootDoc)