org.jdrupes.mdoclet

Interface MarkdownProcessor

All Superinterfaces:

OptionChecker

All Known Implementing Classes:

FlexmarkProcessor

public interface MarkdownProcessor
extends OptionChecker

Provides the interface to the Markdown processor.

Field Summary

Fields

Modifier and Type	Field and Description
static String	INTERNAL_OPT_DISABLE_AUTO_HIGHLIGHT

Method Summary

Modifier and Type	Method and Description
void	start(String[][] options) Starts the processor with the given options.
String	toHtml(String markdown) Converts the given markdown test to HTML.

Methods inherited from interface javax.tools.OptionChecker

isSupportedOption

Field Detail

INTERNAL_OPT_DISABLE_AUTO_HIGHLIGHT

static final String INTERNAL_OPT_DISABLE_AUTO_HIGHLIGHT

See Also:

Constant Field Values

Method Detail

start

void start(String[][] options)

Starts the processor with the given options.

All processors should support the special option _disable-auto-highlight_. The doclet maps its option -disable-auto-highlight to this special processor option because disabling the auto highlight feature is usually implemented by configuring the processors HTML renderer in some way.

Parameters:

options - an array of options; each entry consists of an array that has the option name as first entry and any parameters for that option as subsequent entries

toHtml

String toHtml(String markdown)

Converts the given markdown test to HTML.

Parameters:

markdown - the markdoen text

Returns:

the HTML