org.eclipse.golo.doc

Class HtmlProcessor

java.lang.Object

org.eclipse.golo.doc.AbstractProcessor

org.eclipse.golo.doc.HtmlProcessor

public class HtmlProcessor
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static com.github.rjeschke.txtmark.Configuration	CONFIG

Constructor Summary

Constructors

Constructor and Description
HtmlProcessor()

Method Summary

Modifier and Type	Method and Description
static com.github.rjeschke.txtmark.BlockEmitter	blockHighlighter()
protected java.lang.String	fileExtension()
org.eclipse.golo.doc.DocIndex	globalIndex()
java.lang.String	link(DocumentationElement src, DocumentationElement dst) Returns the direct link to the given documentation element from a given element.
java.lang.String	linkToDoc(java.lang.String src, DocumentationElement dst) Returns the direct link to the given documentation element from a given filename.
static java.lang.String	moduleListItem(ModuleDocumentation doc, java.lang.String target)
void	process(java.util.Collection<ModuleDocumentation> docs, java.nio.file.Path targetFolder)
static java.lang.String	process(java.lang.String documentation)
static java.lang.String	process(java.lang.String documentation, int rootLevel)
static java.lang.String	process(java.lang.String documentation, int rootLevel, com.github.rjeschke.txtmark.Configuration configuration)
java.lang.String	render(ModuleDocumentation documentation)
static java.lang.String	sectionTitle(int level, DocumentationElement doc, java.nio.file.Path src)
static java.lang.String	tocItem(DocumentationElement doc)

Methods inherited from class org.eclipse.golo.doc.AbstractProcessor

adaptSections, addModule, docFile, getPackages, getSubmodulesOf, getTargetFolder, linkToFile, linkToFile, modules, outputFile, renderIndex, setTargetFolder, template

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG

public static final com.github.rjeschke.txtmark.Configuration CONFIG

Constructor Detail

HtmlProcessor

public HtmlProcessor()

Method Detail

fileExtension

protected java.lang.String fileExtension()

Overrides:

fileExtension in class AbstractProcessor

globalIndex

public org.eclipse.golo.doc.DocIndex globalIndex()

linkToDoc

public java.lang.String linkToDoc(java.lang.String src,
                                  DocumentationElement dst)

Returns the direct link to the given documentation element from a given filename.

link

public java.lang.String link(DocumentationElement src,
                             DocumentationElement dst)

Returns the direct link to the given documentation element from a given element.

render

public java.lang.String render(ModuleDocumentation documentation)
                        throws java.lang.Throwable

Specified by:

render in class AbstractProcessor

Throws:

java.lang.Throwable

process

public void process(java.util.Collection<ModuleDocumentation> docs,
                    java.nio.file.Path targetFolder)
             throws java.lang.Throwable

Specified by:

process in class AbstractProcessor

Throws:

java.lang.Throwable

blockHighlighter

public static com.github.rjeschke.txtmark.BlockEmitter blockHighlighter()

sectionTitle

public static java.lang.String sectionTitle(int level,
                                            DocumentationElement doc,
                                            java.nio.file.Path src)

tocItem

public static java.lang.String tocItem(DocumentationElement doc)

moduleListItem

public static java.lang.String moduleListItem(ModuleDocumentation doc,
                                              java.lang.String target)

process

public static java.lang.String process(java.lang.String documentation,
                                       int rootLevel,
                                       com.github.rjeschke.txtmark.Configuration configuration)

process

public static java.lang.String process(java.lang.String documentation,
                                       int rootLevel)

process

public static java.lang.String process(java.lang.String documentation)