de.unkrig.doclet.main

Class MainDoclet

java.lang.Object

de.unkrig.doclet.main.MainDoclet

public final class MainDoclet
extends Object

See Also:

start(RootDoc), Doclet Overview

Method Summary

Modifier and Type	Method and Description
static void	addLinkoffline(String extDocUrl, String packageListLoc) For compatibility with the JAVADOC standard doclet; ignored.
static com.sun.javadoc.LanguageVersion	languageVersion()
static int	optionLength(String option) See "Doclet Overview".
static void	setBottom(String text) For compatibility with the JAVADOC standard doclet; ignored.
static void	setCharset(String name) The HTML character set for this document.
static void	setDestination(File destDir) Where to create the HTML files.
static void	setDocencoding(Charset charset) The charset to use when writing the HTML files.
static void	setDoctitle(String title) The title to place near the top of the output file.
static void	setMethod(String method) The signature of the method to document.
static void	setQuiet() Suppresse normal output.
static void	setWindowtitle(String title) For compatibility with the JAVADOC standard doclet; ignored.
static boolean	start(com.sun.javadoc.RootDoc rootDoc) A doclet that generates simple HTML files for a particular method (e.g.

Methods inherited from class java.lang.Object

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

Method Detail

setDestination

public static void setDestination(File destDir)

Where to create the HTML files.

The effective file name is:

<dest-dir>/<pkg>/<class>.<method>.html

The default destination directory is ".".

setMethod

public static void setMethod(String method)

The signature of the method to document. The default is "main(String[])"; for a doclet, you may want to specify "start(RootDoc)".

setDocencoding

public static void setDocencoding(Charset charset)

The charset to use when writing the HTML files. The default is the JVM default charset, "${file.encoding}".

setCharset

public static void setCharset(String name)

The HTML character set for this document.

setDoctitle

public static void setDoctitle(String title)

The title to place near the top of the output file.

setQuiet

public static void setQuiet()

Suppresse normal output.

setBottom

public static void setBottom(String text)

For compatibility with the JAVADOC standard doclet; ignored.

addLinkoffline

public static void addLinkoffline(String extDocUrl,
                                  String packageListLoc)

For compatibility with the JAVADOC standard doclet; ignored.

setWindowtitle

public static void setWindowtitle(String title)

For compatibility with the JAVADOC standard doclet; ignored.

languageVersion

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

optionLength

public static int optionLength(String option)
                        throws IOException

See "Doclet Overview".

Throws:

IOException

start

public static boolean start(com.sun.javadoc.RootDoc rootDoc)
                     throws IOException

A doclet that generates simple HTML files for a particular method (e.g. "main(String[])") of a set of classes.

Doclet command line options:

Supported inline tags:

{@code text}

{@literal text}

{@value package.class#field}

{@link package.class#member label}

{@linkplain package.class#member label}

{@docRoot}

Same as for the standard doclet.

{@constantsof package.enum-type}

{@constantsofplain package.enum-type}

Links to all constants of the designated enum type, separated with ", " (a comma and a space).

Throws:

IOException