Package com.kscs.util.plugins.xjc.doc

Klasse PluginDocumentationFormatter

java.lang.Object

com.kscs.util.plugins.xjc.doc.PluginDocumentationFormatter

public class PluginDocumentationFormatter
extends Object

Autor:

Mirko Klemm 2015-02-19

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
static final Pattern	INDEX_PATTERN
static final ResourceBundle	RES

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	PluginDocumentationFormatter(AbstractPlugin plugin, Locale locale)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
String	getConfigCheatSheet(int tabAmount, String argPrefix, String argSuffix)
Locale	getLocale()
AbstractPlugin	getPlugin()
String	getUsageFileName()
Document	getUsageHtml(Node parent)
String	getUsageMarkdown()

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

INDEX_PATTERN

public static final Pattern INDEX_PATTERN

RES

public static final ResourceBundle RES

Konstruktordetails

PluginDocumentationFormatter

protected PluginDocumentationFormatter(AbstractPlugin plugin,
 Locale locale)

Methodendetails

getLocale

public Locale getLocale()

getPlugin

public AbstractPlugin getPlugin()

getUsageHtml

public Document getUsageHtml(Node parent)

getUsageMarkdown

public String getUsageMarkdown()

getUsageFileName

public String getUsageFileName()

getConfigCheatSheet

public String getConfigCheatSheet(int tabAmount,
 String argPrefix,
 String argSuffix)