apiDoc documentation JSON data object (api_data.json file content)
OptionaltemplateName of template to be used (default, bitbucket)
or path to EJS template file
or raw EJS plain text template
(will use default template if omitted).
OptionalheaderContent to add at the top of the documentation
OptionalfooterContent to add at the bottom of the documentation
OptionalprependContent to add before route groups documentation
Input source files path
OptionaloutputOutput file or directory to write output to
OptionalheaderPath to file content to add at the top of the documentation
OptionalfooterPath to file content to add at the bottom of the documentation
OptionalprependPath to file content to add before route groups documentation
OptionalmultiOutput one file per group to the output directory
OptionalcreateRecursively create directory arborescence to the output directory
OptionalwarnTreat warnings as error and exit with error code.
apiDoc project JSON data object (
apidoc.json) file content)