public final class MainDoclet extends Object
start(RootDoc),
Doclet
Overview| 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.
|
public static void setDestination(File destDir)
The effective file name is:
<dest-dir>/<pkg>/<class>.<method>.html
The default destination directory is ".".
public static void setMethod(String method)
"start(RootDoc)".public static void setDocencoding(Charset charset)
public static void setCharset(String name)
public static void setDoctitle(String title)
public static void setQuiet()
public static void setBottom(String text)
public static void addLinkoffline(String extDocUrl, String packageListLoc)
public static void setWindowtitle(String title)
public static com.sun.javadoc.LanguageVersion languageVersion()
public static int optionLength(String option) throws IOException
IOExceptionpublic static boolean start(com.sun.javadoc.RootDoc rootDoc)
throws IOException
{@code text}{@literal text}{@value package.class#field}{@link package.class#member label}{@linkplain package.class#member label}{@docRoot}{@constantsof package.enum-type}{@constantsofplain package.enum-type}, " (a comma and a space).
IOExceptionCopyright © 2016 Arno Unkrig. All rights reserved.