synapticloop.documentr.generator

Class Generator

java.lang.Object

synapticloop.documentr.generator.Generator

public class Generator
extends Object

The Generator generates the markdown/adoc file from the documentr.json file. If requested, the Table of contents will also be generated with links to the headings and the back to top links.

Constructor Summary

Constructors

Constructor and Description
Generator(File rootDirectory, String extension, boolean debug) Instantiate a generator, without being attached to a gradle build project
Generator(org.gradle.api.Project project, DocumentrPluginExtension extension) Instantiate a generator which will generate the README file from the documentr.json file.

Method Summary

Modifier and Type	Method and Description
void	generate() Generate the documentation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Generator

public Generator(org.gradle.api.Project project,
                 DocumentrPluginExtension extension)

Instantiate a generator which will generate the README file from the documentr.json file.

Parameters:

project - The gradle project to use

extension - the plugin extension which contains all of the options.

Generator

public Generator(File rootDirectory,
                 String extension,
                 boolean debug)

Instantiate a generator, without being attached to a gradle build project

Parameters:

rootDirectory - The root directory (for both input and output)

extension - The output extension

debug - whether to debug the output

Method Detail

generate

public void generate()
              throws DocumentrException

Generate the documentation. If we are using the default file location, and it doesn't exist, then we will create the file on the fly

Throws:

DocumentrException - if there was an error in generating the documentation