A C D F G M S

A

addDependencies(DependencySet) - Method in class synapticloop.documentr.bean.ConfigurationBean

Add dependencies

apply(Project) - Method in class synapticloop.documentr.plugin.DocumentrPlugin

C

ConfigurationBean - Class in synapticloop.documentr.bean

ConfigurationBean(String) - Constructor for class synapticloop.documentr.bean.ConfigurationBean

THe name of the configuration

D

DocumentrException - Exception in synapticloop.documentr.exception

DocumentrException(String) - Constructor for exception synapticloop.documentr.exception.DocumentrException

Instantiate a documentr exception

DocumentrException(String, Throwable) - Constructor for exception synapticloop.documentr.exception.DocumentrException

Instantiate a documentr exception

DocumentrPlugin - Class in synapticloop.documentr.plugin

DocumentrPlugin() - Constructor for class synapticloop.documentr.plugin.DocumentrPlugin

DocumentrPluginExtension - Class in synapticloop.documentr.plugin

DocumentrPluginExtension() - Constructor for class synapticloop.documentr.plugin.DocumentrPluginExtension

DocumentrTask - Class in synapticloop.documentr.plugin

DocumentrTask() - Constructor for class synapticloop.documentr.plugin.DocumentrTask

F

FILE_NAME_DOCUMENTR_DEFAULT_JSON - Static variable in class synapticloop.documentr.plugin.DocumentrPluginExtension

FILE_NAME_DOCUMENTR_JSON - Static variable in class synapticloop.documentr.plugin.DocumentrPluginExtension

G

generate() - Method in class synapticloop.documentr.generator.Generator

Generate the documentation.

generate() - Method in class synapticloop.documentr.plugin.DocumentrTask

Generator - Class in synapticloop.documentr.generator

Generator(Project, DocumentrPluginExtension) - Constructor for class synapticloop.documentr.generator.Generator

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

Generator(File, String, boolean) - Constructor for class synapticloop.documentr.generator.Generator

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

getDependencies() - Method in class synapticloop.documentr.bean.ConfigurationBean

Get the dependencies for this configuration

getDirectory() - Method in class synapticloop.documentr.plugin.DocumentrPluginExtension

Return the directory that the documentr plugin looks for the 'documentr.json' file, by default this is the current working directory

getDocumentrFile() - Method in class synapticloop.documentr.plugin.DocumentrPluginExtension

Get the documentr file name to be parsed (by default this is 'documentr.json'

getEnd() - Method in class synapticloop.documentr.bean.StartEndBean

getExtension() - Method in class synapticloop.documentr.plugin.DocumentrPluginExtension

Get the output extension, by default this is .md

getName() - Method in class synapticloop.documentr.bean.ConfigurationBean

Get the name of the configuration

getStart() - Method in class synapticloop.documentr.bean.StartEndBean

getVerbose() - Method in class synapticloop.documentr.plugin.DocumentrPluginExtension

Get whether there should be verbose output

M

Main - Class in synapticloop.documentr

Main() - Constructor for class synapticloop.documentr.Main

main(String[]) - Static method in class synapticloop.documentr.Main

S

setDirectory(String) - Method in class synapticloop.documentr.plugin.DocumentrPluginExtension

Set the directory that the 'documentr.json' file resides in

setDocumentrFile(String) - Method in class synapticloop.documentr.plugin.DocumentrPluginExtension

Set the file name to be parsed

setExtension(String) - Method in class synapticloop.documentr.plugin.DocumentrPluginExtension

Set the extension for the output of the file

setVerbose(boolean) - Method in class synapticloop.documentr.plugin.DocumentrPluginExtension

Set whether to have verbose output from documentr

StartEndBean - Class in synapticloop.documentr.bean

StartEndBean(int, int) - Constructor for class synapticloop.documentr.bean.StartEndBean

synapticloop.documentr - package synapticloop.documentr

synapticloop.documentr.bean - package synapticloop.documentr.bean

synapticloop.documentr.exception - package synapticloop.documentr.exception

synapticloop.documentr.generator - package synapticloop.documentr.generator

synapticloop.documentr.plugin - package synapticloop.documentr.plugin

A C D F G M S