DocConfig type (joe.doc)
The DocConfig static type owns the static methods used to
configure the joe doc tool.
- DocConfig.inputFile(filename,...) → this
- DocConfig.inputFolder(folder,...) → this
- DocConfig.outputFolder(folder) → this
Static Methods
DocConfig.inputFile()
DocConfig.inputFile(filename,...) → this
Adds the paths of one or more files to scan for JoeDoc
comments. File paths are relative to the location of the
doc_config.joe file.
DocConfig.inputFolder()
DocConfig.inputFolder(folder,...) → this
Adds the paths of one or more folders to scan for files
containing JoeDoc comments. joe doc will scan all
.java and .joe files in the folders, recursing down
into subfolders.
Folder paths are relative to the location of the
doc_config.joe file.
DocConfig.outputFolder()
DocConfig.outputFolder(folder) → this
Sets the name of the folder to receive the generated outputs.
If unset, defaults to the folder containing the doc_config.joe
file.