Whether or not to write intermediary files used during processing to the output data folder.
A list of strings representing regex patterns for files/folders to ignore. By default the following patterns are already included:
'\/\.'
'\.git'
'node_modules'
Configuration will concat this list with the user provied list.The filename for the shortcut to the index.html file. Use a name that will push the name to the top of the folder for quicker access to the index.hrml file.
NOTE: // sourceRootFolder and dataFolder are injected into the "mainConf" by documon.
Example link other class to root.documon.dirutils.makedir
Example link other class to documon.dirutils.makedir
Example link other class to documon.dirutils
Example link local to #run
The title of the project (displayed in the title of the docs).
The location of the source file or folder to process.
Where the docs will be written to. Defaults to be parallel to source folder.
A list of source files or folders to ignore.
The path to the template folder (defaults to the main documon/template folder)
Your product's version
Delimiter used to signify the START of a source-code comment.
Delimiter used to signify the END of a source-code comment.
Launch the documentation in the browser when done?
The extension of your source code files to parse. For multiple kinds, use a space delimited string (e.g. "js jsx py php").
Whether or not to save intermediary data objects.
The folder name used to house the docs.
(derived by documon) The actual location that a given source file resides within.
(derived by documon) The path used to place data files.
The path to a folder containing addition markdown (.md) files to include.
The name of the index shortcut file to push it to the top of the folder so you don't have to scroll and hunt andpeck for hte "index.html" file to launch the docs.
More quirk delimiter. The character(s) use to seperate the "more" page numbering system from page titles.
Determines if the file has the proper extension based on the acceptable extensions defined in this modules static "extensions" array.
The path or full file name.
Whether or not it's an OK extension.
Initializes Documan based on the configuration settings
See (run)[run], as this configuration object is simply passed through.
False when there's an error or misconfiguration. True when everything seems cool.
The main processing loop that executes and manages the main flow control of parsing, evaluating and
construction of the documentation.
After init configures things based on the settings, and generates a list of files to process
this method process and sends each file to the seeder of evaluation and processing.
The configuration object. See mainConf
Extracts, parses and tags comments from one source file and stuffs the result into organizer.
The path to the file.
The file's search data as computed by tag.js
Extracts, parses and tags comments from one source file and stuffs the result into organizer.
The path to the file.
true = ignore this file, false = don't ignore.
Simplify file write for text or json.
The path to save to.
The string to save
Whether the data should be serialized to JSON or not.