synapticloop.documentr.generator

Class Generator

java.lang.Object

synapticloop.documentr.generator.Generator

public class Generator
extends Object

Constructor Summary

Constructors

Constructor and Description
Generator(File rootDirectory, String extension, boolean debug)
Generator(org.gradle.api.Project project, DocumentrPluginExtension extension)

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)

Generator

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

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