MDoclet (JDrupes MDoclet)

java.lang.Object
- com.sun.javadoc.Doclet
- - org.jdrupes.mdoclet.MDoclet

All Implemented Interfaces:

com.sun.javadoc.DocErrorReporter
```
public class MDoclet
extends com.sun.javadoc.Doclet
implements com.sun.javadoc.DocErrorReporter
```
The Doclet implementation. It converts the Markdown from the JavaDoc comments and tags to HTML and sets a resulting JavaDoc comment using Doc.setRawCommentText(String). It then passes the RootDoc to the standard Doclet.

See Also:

The Doclet Specification

Field Summary

Fields
Modifier and Type Field and Description

static String HIGHLIGHT_JS_HTML

Fields
Modifier and Type	Field and Description
`static String`	`HIGHLIGHT_JS_HTML`

Constructor Summary

Constructors
Constructor and Description

MDoclet(Options options, com.sun.javadoc.RootDoc rootDoc)
Construct a new doclet.

Constructors
Constructor and Description
`MDoclet(Options options, com.sun.javadoc.RootDoc rootDoc)` Construct a new doclet.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTagRenderer(String kind, TagRenderer<?> renderer)` Adds a tag renderer for the specified `kind`.
`void`	`clearProcessor()` Clears the processor.
`void`	`clearTagRenderers()` Removes all tag renderers.
`protected void`	`defaultProcess(com.sun.javadoc.Doc doc, boolean fixLeadingSpaces)` Default processing of any documentation node.
`void`	`error()` Indicate that an error occurred.
`Options`	`getOptions()` Get the options.
`com.sun.javadoc.RootDoc`	`getRootDoc()` Get the root doc.
`boolean`	`isError()` Check whether any errors occurred during processing of the documentation tree.
`static com.sun.javadoc.LanguageVersion`	`languageVersion()` As specified by the Doclet specification.
`static void`	`main(String[] args)` Just a main method for debugging.
`static int`	`optionLength(String option)` As specified by the Doclet specification.
`boolean`	`postProcess()` Called after the standard Doclet successfully did its work.
`void`	`printError(com.sun.javadoc.SourcePosition pos, String msg)`
`void`	`printError(String msg)`
`void`	`printNotice(com.sun.javadoc.SourcePosition pos, String msg)`
`void`	`printNotice(String msg)`
`void`	`printWarning(com.sun.javadoc.SourcePosition pos, String msg)`
`void`	`printWarning(String msg)`
`void`	`process()` Process the documentation tree.
`protected void`	`processClass(com.sun.javadoc.ClassDoc doc)` Process the class documentation.
`protected void`	`processMember(com.sun.javadoc.MemberDoc doc)` Process the member documentation.
`protected void`	`processOverview()` Process the overview file, if specified.
`protected void`	`processPackage(com.sun.javadoc.PackageDoc doc)` Process the package documentation.
`protected void`	`processTag(com.sun.javadoc.Tag tag, StringBuilder target)` Process a tag.
`void`	`removeTagRenderer(String kind)` Removes a tag renderer for the specified `kind`.
`String`	`rootUrlPrefix(com.sun.javadoc.PackageDoc doc)` Returns a prefix for relative URLs from a documentation element relative to the given package.
`static boolean`	`start(com.sun.javadoc.RootDoc rootDoc)` As specified by the Doclet specification.
`String`	`toHtml(String markup)` Convert the given markup to HTML according to the `Options`.
`String`	`toHtml(String markup, boolean fixLeadingSpaces)` Converts Markdown source to HTML according to the options object.
`static boolean`	`validOptions(String[][] options, com.sun.javadoc.DocErrorReporter errorReporter)` As specified by the Doclet specification.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - HIGHLIGHT_JS_HTML
```
public static final String HIGHLIGHT_JS_HTML
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - MDoclet
```
public MDoclet(Options options,
               com.sun.javadoc.RootDoc rootDoc)
```
    Construct a new doclet.
    
    Parameters:
    
    options - The command line options.
    
    rootDoc - The root document.
- Method Detail
  - languageVersion
```
public static com.sun.javadoc.LanguageVersion languageVersion()
```
    As specified by the Doclet specification.
    
    Returns:
    
    Java 1.5.
    
    See Also:
    
    Doclet.languageVersion()
  - optionLength
```
public static int optionLength(String option)
```
    As specified by the Doclet specification.
    
    Parameters:
    
    option - The option name.
    
    Returns:
    
    The length of the option.
    
    See Also:
    
    Doclet.optionLength(String)
  - validOptions
```
public static boolean validOptions(String[][] options,
                                   com.sun.javadoc.DocErrorReporter errorReporter)
```
    As specified by the Doclet specification.
    
    Parameters:
    
    options - The command line options.
    
    errorReporter - An error reporter to print errors.
    
    Returns:
    
    true, if the options are valid.
  - start
```
public static boolean start(com.sun.javadoc.RootDoc rootDoc)
```
    As specified by the Doclet specification.
    
    Parameters:
    
    rootDoc - The root doc.
    
    Returns:
    
    true, if process was successful.
    
    See Also:
    
    Doclet.start(RootDoc)
  - clearTagRenderers
```
public void clearTagRenderers()
```
    Removes all tag renderers.
  - addTagRenderer
```
public void addTagRenderer(String kind,
                           TagRenderer<?> renderer)
```
    Adds a tag renderer for the specified kind.
    
    Parameters:
    
    kind - The kind of the tag the renderer renders.
    
    renderer - The tag renderer.
  - removeTagRenderer
```
public void removeTagRenderer(String kind)
```
    Removes a tag renderer for the specified kind.
    
    Parameters:
    
    kind - The kind of the tag.
  - getOptions
```
public Options getOptions()
```
    Get the options.
    
    Returns:
    
    The options.
  - getRootDoc
```
public com.sun.javadoc.RootDoc getRootDoc()
```
    Get the root doc.
    
    Returns:
    
    The root doc.
  - process
```
public void process()
```
    Process the documentation tree. If any errors occur during processing, isError() will return true afterwards.
  - postProcess
```
public boolean postProcess()
```
    Called after the standard Doclet successfully did its work.
    
    Returns:
    
    true if postprocessing succeeded.
  - isError
```
public boolean isError()
```
    Check whether any errors occurred during processing of the documentation tree.
    
    Returns:
    
    true if there were errors processing the documentation tree.
  - processOverview
```
protected void processOverview()
```
    Process the overview file, if specified.
  - processClass
```
protected void processClass(com.sun.javadoc.ClassDoc doc)
```
    Process the class documentation.
    
    Parameters:
    
    doc - The class documentation.
  - processMember
```
protected void processMember(com.sun.javadoc.MemberDoc doc)
```
    Process the member documentation.
    
    Parameters:
    
    doc - The member documentation.
  - processPackage
```
protected void processPackage(com.sun.javadoc.PackageDoc doc)
```
    Process the package documentation.
    
    Parameters:
    
    doc - The package documentation.
  - defaultProcess
```
protected void defaultProcess(com.sun.javadoc.Doc doc,
                              boolean fixLeadingSpaces)
```
    Default processing of any documentation node.
    
    Parameters:
    
    doc - The documentation.
    
    fixLeadingSpaces - true if leading spaces should be fixed.
  - processTag
```
protected void processTag(com.sun.javadoc.Tag tag,
                          StringBuilder target)
```
    Process a tag.
    
    Parameters:
    
    tag - The tag.
    
    target - The target string builder.
  - clearProcessor
```
public void clearProcessor()
```
    Clears the processor.
  - toHtml
```
public String toHtml(String markup)
```
    Convert the given markup to HTML according to the Options.
    
    Parameters:
    
    markup - The Markdown source.
    
    Returns:
    
    The resulting HTML.
  - toHtml
```
public String toHtml(String markup,
                     boolean fixLeadingSpaces)
```
    Converts Markdown source to HTML according to the options object. If fixLeadingSpaces is true, exactly one leading whitespace character (‘\u0020’) will be removed, if it exists.
    
    Parameters:
    
    markup - The Markdown source.
    
    fixLeadingSpaces - true if leading spaces should be fixed.
    
    Returns:
    
    The resulting HTML.
  - error
```
public void error()
```
    Indicate that an error occurred. This method will also be called by printError(String) and printError(com.sun.javadoc.SourcePosition, String).
  - printError
```
public void printError(String msg)
```
    Specified by:
    
    printError in interface com.sun.javadoc.DocErrorReporter
  - printError
```
public void printError(com.sun.javadoc.SourcePosition pos,
                       String msg)
```
    Specified by:
    
    printError in interface com.sun.javadoc.DocErrorReporter
  - printWarning
```
public void printWarning(String msg)
```
    Specified by:
    
    printWarning in interface com.sun.javadoc.DocErrorReporter
  - printWarning
```
public void printWarning(com.sun.javadoc.SourcePosition pos,
                         String msg)
```
    Specified by:
    
    printWarning in interface com.sun.javadoc.DocErrorReporter
  - printNotice
```
public void printNotice(String msg)
```
    Specified by:
    
    printNotice in interface com.sun.javadoc.DocErrorReporter
  - printNotice
```
public void printNotice(com.sun.javadoc.SourcePosition pos,
                        String msg)
```
    Specified by:
    
    printNotice in interface com.sun.javadoc.DocErrorReporter
  - rootUrlPrefix
```
public String rootUrlPrefix(com.sun.javadoc.PackageDoc doc)
```
    Returns a prefix for relative URLs from a documentation element relative to the given package. This prefix can be used to refer to the root URL of the documentation:
```
doc = "<script type=\"text/javascript\" src=\""
   + rootUrlPrefix(classDoc.containingPackage()) + "highlight.js"
   + "\"></script>";
```
    Parameters:
    
    doc - The package containing the element from where to reference the root.
    
    Returns:
    
    A URL prefix for URLs referring to the doc root.
  - main
```
public static void main(String[] args)
                 throws Exception
```
    Just a main method for debugging.
    
    Parameters:
    
    args - The command line arguments.
    
    Throws:
    
    Exception - If anything goes wrong.

Class MDoclet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HIGHLIGHT_JS_HTML

Constructor Detail

MDoclet

Method Detail

languageVersion

optionLength

validOptions

start

clearTagRenderers

addTagRenderer

removeTagRenderer

getOptions

getRootDoc

process

postProcess

isError

processOverview

processClass

processMember

processPackage

defaultProcess

processTag

clearProcessor

toHtml

toHtml

error

printError

printError

printWarning

printWarning

printNotice

printNotice

rootUrlPrefix

main