Class MarkdownDoclet

java.lang.Object
io.github.sandydunlop.markista.doclet.MarkdownDoclet

All Implemented Interfaces:
Doclet

Nested Class Summary

Modifier and Type	Class	Description
abstract	MarkdownDoclet.Option	A base class for declaring options.

Modifier and Type	Field	Description
private String	outputDirectory
private final Set<MarkdownDoclet.Option>	options
private boolean	documentPrivateMembers
private boolean	createExternalLinks
private static final boolean	OK
private static final boolean	FAILED

Constructor	Description
MarkdownDoclet()	The default constructor, does nothing.

Modifier and Type	Method	Description
boolean	run(DocletEnvironment environment)
static void	main(String[] args)
void	init(Locale locale, Reporter reporter)	Initializes the doclet.
SourceVersion	getSupportedSourceVersion()
Set<? extends MarkdownDoclet.Option>	getSupportedOptions()
String	getName()

boolean run(DocletEnvironment environment)

Returns:

[true if completed without errors, false if errors occurred.]

static void main(String[] args)

void init(Locale locale, Reporter reporter)

Initializes the doclet.

Parameters:

locale - Initializes the doclet.

reporter - Initializes the doclet.

SourceVersion getSupportedSourceVersion()

Set<? extends MarkdownDoclet.Option> getSupportedOptions()

String getName()