Package org.jdrupes.mdoclet

Klasse MDoclet

java.lang.Object

org.jdrupes.mdoclet.MDoclet

Alle implementierten Schnittstellen:

Doclet

public class MDoclet
extends Object
implements Doclet

The Doclet implementation, which converts the Markdown from the JavaDoc comments and tags to HTML.

The doclet works by installing wrappers to intercept the HtmlDoclet’s calls to access the DocCommentTrees (see DocCommentTreeWrapper). At the root of this interception is a modified doclet environment (MDocletEnvironment) that installs a wrapper around doc trees access.

For some strange reason, the StandardDoclet does not work with interface DocletEnvironment but insists on the instance being a DocEnvImpl. Therefore MDocletEnvironment has to extend this class which requires to allow module access with --add-exports=jdk.javadoc/org.jdrupes.mdoclet.internal.tool=ALL-UNNAMED.

Verschachtelte Klassen - Übersicht

Von Schnittstelle geerbte verschachtelte Klassen/Schnittstellen jdk.javadoc.doclet.Doclet

Doclet.Option

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final String	HIGHLIGHT_JS_HTML

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
MDoclet()

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
String	getName()
MarkdownProcessor	getProcessor()	Returns the processor selected by the options.
Set<? extends Doclet.Option>	getSupportedOptions()
SourceVersion	getSupportedSourceVersion()
void	init(Locale locale, Reporter reporter)
boolean	run(DocletEnvironment environment)

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

HIGHLIGHT_JS_HTML

public static final String HIGHLIGHT_JS_HTML

Siehe auch:

• Konstantenfeldwerte

Konstruktordetails

MDoclet

public MDoclet()

Methodendetails

init

public void init(Locale locale,
 Reporter reporter)

Angegeben von:

init in Schnittstelle Doclet

getName

public String getName()

Angegeben von:

getName in Schnittstelle Doclet

getSupportedOptions

public Set<? extends Doclet.Option> getSupportedOptions()

Angegeben von:

getSupportedOptions in Schnittstelle Doclet

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Angegeben von:

getSupportedSourceVersion in Schnittstelle Doclet

run

public boolean run(DocletEnvironment environment)

Angegeben von:

run in Schnittstelle Doclet

getProcessor

public MarkdownProcessor getProcessor()

Returns the processor selected by the options.

Gibt zurück:

the processor