public class
DocdownDoclet
extends com.sun.javadoc.Doclet
Overview
Doclet entry point
Summary
| Fields | |
|---|---|
| private static DocdownOption | docdownOption Options |
| private static RootProjectDoc | projectDoc Root markup and resources doc |
| private static com.sun.javadoc.RootDoc | rootDoc Root of javavadoc |
| public static final String | version Docdown verison string |
| Constructors | |
|---|---|
| public | DocdownDoclet() |
| Methods | |
|---|---|
| private static DocGenerator | createDocGenerator(com.sun.javadoc.RootDoc rootDoc, RootProjectDoc rootProjectDoc, RefLocator refLocator, DocdownOption options, DocPageStore store) Create the document generator. |
| public static com.sun.javadoc.DocErrorReporter | getErrorReporter() Gets the error reporter |
| public static com.sun.javadoc.LanguageVersion | languageVersion() Return the version of the Java Programming Language supported by this doclet. |
| private static String | loadVersion() |
| public static int | optionLength(String option) Check for doclet-added options. |
| public static boolean | start(com.sun.javadoc.RootDoc root) Generate documentation here. |
| public static boolean | validOptions(String options[][], com.sun.javadoc.DocErrorReporter reporter) Check that options have the correct arguments. |
| from Object | |
Fields
public static final String version
Docdown verison string
private static DocdownOption docdownOption
Options
private static RootProjectDoc projectDoc
Root markup and resources doc
Root of javavadoc
Constructors
Methods
Gets the error reporter
Returns:
error reporter
Generate documentation here. This method is required for all doclets.
Parameters:
root: the javadoc root document
Returns:
true on success.
private static DocGenerator createDocGenerator(com.sun.javadoc.RootDoc rootDoc, RootProjectDoc rootProjectDoc, RefLocator refLocator, DocdownOption options, DocPageStore store)
Create the document generator.
Parameters:
rootDoc: javadoc root doc
rootProjectDoc: markupdoc root dof
refLocator: reference locator
options: options
store: document store
Returns:
the doc generator
Return the version of the Java Programming Language supported by this doclet.
Returns:
the language version supported by this doclet.
public static int optionLength(String option)
Check for doclet-added options. Returns the number of arguments you must specify on the command line for the given option.
Parameters:
option: the option to check
Returns:
number of arguments on the command line for an option including the option name itself. Zero return means option not known. Negative value means error occurred.
public static boolean validOptions(String options[][], com.sun.javadoc.DocErrorReporter reporter)
Check that options have the correct arguments.
Parameters:
options: the command line options
reporter: error reporter
Returns:
true if the options are valid.
private static String loadVersion()