synapticloop.documentr.plugin

Class DocumentrPluginExtension

java.lang.Object

synapticloop.documentr.plugin.DocumentrPluginExtension

public class DocumentrPluginExtension
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILE_NAME_DOCUMENTR_DEFAULT_JSON
static String	FILE_NAME_DOCUMENTR_JSON

Constructor Summary

Constructors

Constructor and Description
DocumentrPluginExtension()

Method Summary

Modifier and Type	Method and Description
String	getDirectory() Return the directory that the documentr plugin looks for the 'documentr.json' file, by default this is the current working directory
String	getDocumentrFile() Get the documentr file name to be parsed (by default this is 'documentr.json'
String	getExtension() Get the output extension, by default this is .md
boolean	getVerbose() Get whether there should be verbose output
void	setDirectory(String directory) Set the directory that the 'documentr.json' file resides in
void	setDocumentrFile(String documentrFile) Set the file name to be parsed
void	setExtension(String extension) Set the extension for the output of the file
void	setVerbose(boolean verbose) Set whether to have verbose output from documentr

Methods inherited from class java.lang.Object

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

Field Detail

FILE_NAME_DOCUMENTR_JSON

public static final String FILE_NAME_DOCUMENTR_JSON

See Also:

Constant Field Values

FILE_NAME_DOCUMENTR_DEFAULT_JSON

public static final String FILE_NAME_DOCUMENTR_DEFAULT_JSON

See Also:

Constant Field Values

Constructor Detail

DocumentrPluginExtension

public DocumentrPluginExtension()

Method Detail

getDirectory

public String getDirectory()

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

Returns:

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

setDirectory

public void setDirectory(String directory)

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

Parameters:

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

getVerbose

public boolean getVerbose()

Get whether there should be verbose output

Returns:

whether documentr should be verbose

setVerbose

public void setVerbose(boolean verbose)

Set whether to have verbose output from documentr

Parameters:

verbose - whether to output verbose information

getExtension

public String getExtension()

Get the output extension, by default this is .md

Returns:

get the extension for the output

setExtension

public void setExtension(String extension)

Set the extension for the output of the file

Parameters:

extension - the extension for the output of the file

getDocumentrFile

public String getDocumentrFile()

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

Returns:

the file name to be parsed by documentr

setDocumentrFile

public void setDocumentrFile(String documentrFile)

Set the file name to be parsed

Parameters:

documentrFile - the file name to be parsed