io.warp10.warpfleet.doc.generators

Class HTMLGenerator

java.lang.Object

io.warp10.warpfleet.doc.generators.AbstractGenerator

io.warp10.warpfleet.doc.generators.MarkdownGenerator

io.warp10.warpfleet.doc.generators.HTMLGenerator

Direct Known Subclasses:

PDFGenerator

public class HTMLGenerator
extends MarkdownGenerator

The type Html generator.

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.vladsch.flexmark.util.data.DataHolder	OPTIONS The constant OPTIONS.
protected com.vladsch.flexmark.parser.Parser	parser The Parser.
protected com.vladsch.flexmark.html.HtmlRenderer	renderer The Renderer.

Constructor Summary

Constructors

Constructor and Description
HTMLGenerator() Instantiates a new Html generator.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	generateHTMLIndex(kong.unirest.json.JSONObject i, java.lang.String dest) Generate html index string.
java.util.List<kong.unirest.json.JSONObject>	output(java.io.File dest, java.util.List<kong.unirest.json.JSONObject> doc) Output list.
protected java.lang.String	wrapHTML(java.lang.String html, java.lang.String title) Wrap html string.

Methods inherited from class io.warp10.warpfleet.doc.generators.MarkdownGenerator

getMarkdown

Methods inherited from class io.warp10.warpfleet.doc.generators.AbstractGenerator

generateSignature, sanitize

Methods inherited from class java.lang.Object

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

Field Detail

OPTIONS

protected static final com.vladsch.flexmark.util.data.DataHolder OPTIONS

The constant OPTIONS.

parser

protected final com.vladsch.flexmark.parser.Parser parser

The Parser.

renderer

protected final com.vladsch.flexmark.html.HtmlRenderer renderer

The Renderer.

Constructor Detail

HTMLGenerator

public HTMLGenerator()

Instantiates a new Html generator.

Method Detail

output

public java.util.List<kong.unirest.json.JSONObject> output(java.io.File dest,
                                                           java.util.List<kong.unirest.json.JSONObject> doc)
                                                    throws java.io.IOException

Description copied from class: AbstractGenerator

Output list.

Overrides:

output in class MarkdownGenerator

Parameters:

dest - the dest

doc - the doc

Returns:

the list

Throws:

java.io.IOException - the io exception

generateHTMLIndex

protected java.lang.String generateHTMLIndex(kong.unirest.json.JSONObject i,
                                             java.lang.String dest)

Generate html index string.

Parameters:

i - the

dest - the dest

Returns:

the string

wrapHTML

protected java.lang.String wrapHTML(java.lang.String html,
                                    java.lang.String title)

Wrap html string.

Parameters:

html - the html

title - the title

Returns:

the string