org.eclipse.golo.doc

Class AbstractProcessor

java.lang.Object

org.eclipse.golo.doc.AbstractProcessor

Direct Known Subclasses:

CtagsProcessor, HtmlProcessor, MarkdownProcessor

public abstract class AbstractProcessor
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
AbstractProcessor()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	adaptSections(java.lang.String documentation, int rootLevel)
protected void	addModule(ModuleDocumentation module)
java.nio.file.Path	docFile(DocumentationElement doc) Return the absolute path of the file containing the given element.
protected java.lang.String	fileExtension()
java.util.Set<java.util.Map.Entry<java.lang.String,java.util.Set<ModuleDocumentation>>>	getPackages()
protected java.util.Set<ModuleDocumentation>	getSubmodulesOf(ModuleDocumentation doc)
java.nio.file.Path	getTargetFolder()
java.lang.String	linkToFile(DocumentationElement src, java.lang.String dst) Returns the link to the given filename from the given document.
java.lang.String	linkToFile(java.lang.String src, java.lang.String dst) Returns the link to the given filename from the given filename.
java.util.Set<ModuleDocumentation>	modules()
java.nio.file.Path	outputFile(java.lang.String name)
abstract void	process(java.util.Collection<ModuleDocumentation> modules, java.nio.file.Path targetFolder)
abstract java.lang.String	render(ModuleDocumentation module)
protected void	renderIndex(java.lang.String templateName)
void	setTargetFolder(java.nio.file.Path target)
protected FunctionReference	template(java.lang.String name, java.lang.String format)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractProcessor

public AbstractProcessor()

Method Detail

render

public abstract java.lang.String render(ModuleDocumentation module)
                                 throws java.lang.Throwable

Throws:

java.lang.Throwable

process

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

Throws:

java.lang.Throwable

setTargetFolder

public void setTargetFolder(java.nio.file.Path target)

getTargetFolder

public java.nio.file.Path getTargetFolder()

modules

public java.util.Set<ModuleDocumentation> modules()

addModule

protected void addModule(ModuleDocumentation module)

getSubmodulesOf

protected java.util.Set<ModuleDocumentation> getSubmodulesOf(ModuleDocumentation doc)

getPackages

public java.util.Set<java.util.Map.Entry<java.lang.String,java.util.Set<ModuleDocumentation>>> getPackages()

fileExtension

protected java.lang.String fileExtension()

template

protected FunctionReference template(java.lang.String name,
                                     java.lang.String format)
                              throws java.io.IOException

Throws:

java.io.IOException

outputFile

public java.nio.file.Path outputFile(java.lang.String name)

docFile

public java.nio.file.Path docFile(DocumentationElement doc)

Return the absolute path of the file containing the given element.

linkToFile

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

Returns the link to the given filename from the given document.

linkToFile

public java.lang.String linkToFile(java.lang.String src,
                                   java.lang.String dst)

Returns the link to the given filename from the given filename.

renderIndex

protected void renderIndex(java.lang.String templateName)
                    throws java.lang.Throwable

Throws:

java.lang.Throwable

adaptSections

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