io.warp10.warpfleet.doc.generators

Class MarkdownGenerator

java.lang.Object

io.warp10.warpfleet.doc.generators.AbstractGenerator

io.warp10.warpfleet.doc.generators.MarkdownGenerator

Direct Known Subclasses:

HTMLGenerator

public class MarkdownGenerator
extends AbstractGenerator

The type Markdown generator.

Constructor Summary

Constructors

Constructor and Description
MarkdownGenerator() Instantiates a new Markdown generator.

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	getMarkdown(kong.unirest.json.JSONObject docObj, java.lang.String title) Gets markdown.
java.util.List<kong.unirest.json.JSONObject>	output(java.io.File dest, java.util.List<kong.unirest.json.JSONObject> doc) Output list.

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

Constructor Detail

MarkdownGenerator

public MarkdownGenerator()

Instantiates a new Markdown 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.

Specified by:

output in class AbstractGenerator

Parameters:

dest - the dest

doc - the doc

Returns:

the list

Throws:

java.io.IOException - the io exception

getMarkdown

protected java.lang.String getMarkdown(kong.unirest.json.JSONObject docObj,
                                       java.lang.String title)

Gets markdown.

Parameters:

docObj - the doc obj

title - the title

Returns:

the markdown