Editing
MAIN doclet
(section)
Jump to navigation
Jump to search
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
== Usage == <html> <h3>Doclet command line options:</h3> <dl> <dt><code>-d</code> <var>dest-dir</var></dt> <dt><code>--destination</code> <var>dest-dir</var></dt> <dd>Where to create the HTML files. <p> The effective file name is: </p> <p> <code><dest-dir>/<pkg>/<class>.<method>.html</code> </p> <p> The default destination directory is "<code>.</code>". </p></dd> <dt><code>--method</code> <var>method</var></dt> <dd>The signature of the method to document. The default is "main(String[])"; for a doclet, you may want to specify <code>"start(RootDoc)"</code>.</dd> <dt><code>--docencoding</code> <var>charset</var></dt> <dd>The charset to use when writing the HTML files. The default is the JVM default charset, "${file.encoding}".</dd> <dt><code>--charset</code> <var>name</var></dt> <dd>The HTML character set for this document. <p> If set, then the following tag appears in the <code><head></code> of all generated documents: </p> <p> <code><meta http-equiv="Content-Type" content="text/html; charset="</code><var>charset</var><code>"></code> </p></dd> <dt><code>--doctitle</code> <var>title</var></dt> <dd>The title to place near the top of the output file.</dd> <dt><code>--quiet</code></dt> <dd>Suppresse normal output.</dd> <dt><code>--bottom</code> <var>text</var></dt> <dd>For compatibility with the JAVADOC standard doclet; ignored.</dd> <dt><code>--linkoffline</code> <var>ext-doc-url</var> <var>package-list-loc</var></dt> <dd>For compatibility with the JAVADOC standard doclet; ignored.</dd> <dt><code>--windowtitle</code> <var>title</var></dt> <dd>For compatibility with the JAVADOC standard doclet; ignored.</dd> </dl> <h3>Supported inline tags:</h3> <dl> <dt><a name="main.commandLineOptions"></a><code>{@main.commandLineOptions}</code></dt> <dt><code>{@main.commandLineOptions</code> <var>group-name</var><code>}</code></dt> <dd> Documentation for all command line options, generated from <code><a href="http://commons.unkrig.de/javadoc/commons-util/de/unkrig/commons/util/annotation/CommandLineOption.html">@CommandLineOption</a></code>-annotated setter methods.<br /> If a <var>group-name</var> is given, then only those options appear which have a <a href="#main.commandLineOptionGroup"><code>{@main.commandLineOptionGroup}</code> block tag</a> with equal <var>group-name</var>; otherwise, only those options appear which have <em>no</em> <code>{@main.commandLineOptionGroup}</code> block tag. </dd> <dt><code>{@code <var>text</var>}</code></dt> <dt><code>{@literal <var>text</var>}</code></dt> <dt><code>{@value <var>package</var>.<var>class</var>#<var>field</var>}</code></dt> <dt><code>{@link <var>package</var>.<var>class</var>#<var>member</var> <var>label</var>}</code></dt> <dt><code>{@linkplain <var>package</var>.<var>class</var>#<var>member</var> <var>label</var>}</code></dt> <dt><code>{@docRoot}</code></dt> <dd> <a href="http://docs.oracle.com/javase/7/docs/technotes/tools/windows/javadoc.html#javadoctags">Same as for the standard doclet</a>. </dd> <dt><code>{@constantsof <var>package</var>.<var>enum-type</var>}</code></dt> <dt><code>{@constantsofplain <var>package</var>.<var>enum-type</var>}</code></dt> <dd> Links to all constants of the designated enum type, separated with "<code>, </code>" (a comma and a space). </dd> </dl> <h3>Supported block tags:</h3> <dl> <dt> <a name="main.commandLineOptionGroup"></a><code>{@main.commandLineOptionGroup}</code> <var>group-name</var> </dt> <dd> Assigns this command line option setter method to a "group"; see <a href="#main.commandLineOptions">the <code>{@main.commandLineOptions}</code> inline tag</a>. </dd> </dl> </html>
Summary:
Please note that all contributions to unkrig.de may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see
Unkrig.de:Copyrights
for details).
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)
Navigation menu
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
Page
Discussion
English
Views
Read
Edit
View history
More
Search
Navigation
Main page
Recent changes
Random page
Help
Tools
What links here
Related changes
Special pages
Page information