doks
Version:
A configurable, bring-your-own-template documentation generator aimed for user and developer documentation based on source code.
884 lines • 41 kB
JSON
{
"parsed": [
{
"_name": "Regex",
"_children": [
{
"_name": "Class",
"_children": [
{
"lineNumber": 12,
"endLineNumber": 18,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This class contains all of the regular expressions used by Parser."
},
"name": {
"name": "name",
"basicInfo": "Expressions"
},
"category": {
"name": "category",
"basicInfo": "Class"
},
"package": {
"name": "package",
"basicInfo": "Regex"
}
}
]
},
{
"_name": "Comment",
"_children": [
{
"lineNumber": 36,
"endLineNumber": 45,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"supports": [
{
"name": "supports",
"type": "js"
},
{
"name": "supports",
"type": "coffee"
},
{
"name": "supports",
"type": "escapedCoffee"
}
],
"desc": {
"name": "desc",
"basicInfo": "This regular expression is used to determine if a line is an ending character sequence."
},
"name": {
"name": "name",
"basicInfo": "END_COMMENT"
},
"category": {
"name": "category",
"basicInfo": "Comment"
},
"package": {
"name": "package",
"basicInfo": "Regex"
}
},
{
"lineNumber": 51,
"endLineNumber": 61,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"supports": [
{
"name": "supports",
"type": "js"
},
{
"name": "supports",
"type": "coffee"
},
{
"name": "supports",
"type": "escapedCoffee"
}
],
"desc": {
"name": "desc",
"basicInfo": "This regular expression is used to determine if a character sequence precedes a comment line."
},
"name": {
"name": "name",
"basicInfo": "LINE_HEAD_CHAR"
},
"category": {
"name": "category",
"basicInfo": "Comment"
},
"package": {
"name": "package",
"basicInfo": "Regex"
}
},
{
"lineNumber": 21,
"endLineNumber": 30,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"supports": [
{
"name": "supports",
"type": "js"
},
{
"name": "supports",
"type": "coffee"
},
{
"name": "supports",
"type": "escapedCoffee"
}
],
"desc": {
"name": "desc",
"basicInfo": "This regular expression is used to determine if a line is a starting character sequence."
},
"name": {
"name": "name",
"basicInfo": "START_COMMENT"
},
"category": {
"name": "category",
"basicInfo": "Comment"
},
"package": {
"name": "package",
"basicInfo": "Regex"
}
}
]
},
{
"_name": "Line",
"_children": [
{
"lineNumber": 67,
"endLineNumber": 73,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This regular expression is used to split a file by lines."
},
"name": {
"name": "name",
"basicInfo": "LINES"
},
"category": {
"name": "category",
"basicInfo": "Line"
},
"package": {
"name": "package",
"basicInfo": "Regex"
}
}
]
},
{
"_name": "Tag",
"_children": [
{
"lineNumber": 76,
"endLineNumber": 83,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This regular expression is used to split a comment line into its appropriate tokens",
"extendedInfo": "tagName, tagType, tagBasicInfo, tagExtendedInfo"
},
"name": {
"name": "name",
"basicInfo": "TAG_SPLIT"
},
"category": {
"name": "category",
"basicInfo": "Tag"
},
"package": {
"name": "package",
"basicInfo": "Regex"
}
}
]
}
]
},
{
"_name": "TagParser",
"_children": [
{
"_name": "Class",
"_children": [
{
"lineNumber": 86,
"endLineNumber": 92,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This class contains all of the regular expressions used by Parser."
},
"name": {
"name": "name",
"basicInfo": "Parser"
},
"category": {
"name": "category",
"basicInfo": "Class"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
}
}
]
},
{
"_name": "Function",
"_children": [
{
"lineNumber": 95,
"endLineNumber": 102,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"param": [
{
"name": "param",
"type": "object",
"basicInfo": "options"
}
],
"desc": {
"name": "desc",
"basicInfo": "This function makes a new parser."
},
"name": {
"name": "name",
"basicInfo": "constructor"
},
"category": {
"name": "category",
"basicInfo": "Function"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
}
},
{
"lineNumber": 456,
"endLineNumber": 463,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This function copies the specified template to the output directory specified. It also handles merging any template options."
},
"name": {
"name": "name",
"basicInfo": "copyTemplate"
},
"category": {
"name": "category",
"basicInfo": "Function"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
}
},
{
"lineNumber": 265,
"endLineNumber": 274,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This function returns a list of files based on options.glob."
},
"name": {
"name": "name",
"basicInfo": "getFiles"
},
"category": {
"name": "category",
"basicInfo": "Function"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"internal": {
"name": "internal"
},
"return": {
"name": "return",
"type": "array",
"basicInfo": "The files found in the given glob"
}
},
{
"lineNumber": 434,
"endLineNumber": 441,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This function takes the options.json glob and gathers all of the specified JSON files into an object."
},
"name": {
"name": "name",
"basicInfo": "getJSON"
},
"category": {
"name": "category",
"basicInfo": "Function"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"return": {
"name": "return",
"type": "object",
"basicInfo": "A hash of each JSON file mapped to its contents, as an object"
}
},
{
"lineNumber": 252,
"endLineNumber": 261,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"param": [
{
"name": "param",
"type": "string",
"basicInfo": "filePath",
"extendedInfo": "The filePath to split apart"
}
],
"desc": {
"name": "desc",
"basicInfo": "This function turns a file path into just a file name."
},
"name": {
"name": "name",
"basicInfo": "getOnlyFileName"
},
"category": {
"name": "category",
"basicInfo": "Function"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"internal": {
"name": "internal"
},
"return": {
"name": "return",
"type": "string",
"basicInfo": "The file name"
}
},
{
"lineNumber": 282,
"endLineNumber": 292,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"param": [
{
"name": "param",
"type": "object",
"basicInfo": "commentData",
"extendedInfo": "{lineNumber, endLineNumber, file}"
}
],
"desc": {
"name": "desc",
"basicInfo": "This function takes a comment object and turns the underlying data into a more digestible format using TAG_SPLIT. It takes into account options like defaults and arrayTags to better format the resulting data."
},
"name": {
"name": "name",
"basicInfo": "handleComment"
},
"category": {
"name": "category",
"basicInfo": "Function"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"internal": {
"name": "internal"
},
"return": {
"name": "return",
"type": "object",
"basicInfo": "The new comment object"
}
},
{
"lineNumber": 351,
"endLineNumber": 361,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This function parses a file, line by line, and gathers the appropriate data to create a basic comment object",
"extendedInfo": "including line numbers). Additionally, if you only wanted comment data (and are using this tool programmatically"
},
"name": {
"name": "name",
"basicInfo": "parse"
},
"category": {
"name": "category",
"basicInfo": "Function"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"throws": {
"name": "throws",
"type": "Error",
"basicInfo": "if a language is not set"
},
"return": {
"name": "return",
"type": "array",
"basicInfo": "An unsorted array of comment data"
}
},
{
"lineNumber": 410,
"endLineNumber": 417,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This function takes flat doks array and sorts it according to options.keySort."
},
"name": {
"name": "name",
"basicInfo": "parseIntoTree"
},
"category": {
"name": "category",
"basicInfo": "Function"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"return": {
"name": "return",
"type": "object",
"basicInfo": "A recursive tree representing nodes as defined by options.keySort"
}
},
{
"lineNumber": 111,
"endLineNumber": 119,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"param": [
{
"name": "param",
"type": "string",
"basicInfo": "file",
"extendedInfo": "The configuration file to parse, defaults to doks.json"
}
],
"desc": {
"name": "desc",
"basicInfo": "This function parses options out of a file, formatted similarly to the options object."
},
"name": {
"name": "name",
"basicInfo": "parseNewOptions"
},
"category": {
"name": "category",
"basicInfo": "Function"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"internal": {
"name": "internal"
}
},
{
"lineNumber": 126,
"endLineNumber": 134,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"param": [
{
"name": "param",
"type": "object",
"basicInfo": "options",
"extendedInfo": "The options object to parse"
}
],
"desc": {
"name": "desc",
"basicInfo": "This function sets options on the Parser object."
},
"name": {
"name": "name",
"basicInfo": "setOptions"
},
"category": {
"name": "category",
"basicInfo": "Function"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"internal": {
"name": "internal"
}
},
{
"lineNumber": 473,
"endLineNumber": 480,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This function aggregates all possible data",
"extendedInfo": "parse times, git metadata, JSON, parsed comment data, theme-related options"
},
"name": {
"name": "name",
"basicInfo": "write"
},
"category": {
"name": "category",
"basicInfo": "Function"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
}
}
]
},
{
"_name": "Option",
"_children": [
{
"lineNumber": 167,
"endLineNumber": 175,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This option lets the parser know what tags happen in multiples. This avoids collisions without too much guessing magic."
},
"name": {
"name": "name",
"basicInfo": "arrayTags"
},
"category": {
"name": "category",
"basicInfo": "Option"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"default": {
"name": "default",
"type": "array",
"basicInfo": "[]"
}
},
{
"lineNumber": 178,
"endLineNumber": 186,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This option lets the parser know what a tags default value should be if it isn't set. Beware, this will be set on every comment object being put through the parser."
},
"name": {
"name": "name",
"basicInfo": "defaults"
},
"category": {
"name": "category",
"basicInfo": "Option"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"default": {
"name": "default",
"type": "object",
"basicInfo": "{}"
}
},
{
"lineNumber": 147,
"endLineNumber": 154,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This option determines which files to glob together when generating doks."
},
"name": {
"name": "name",
"basicInfo": "glob"
},
"category": {
"name": "category",
"basicInfo": "Option"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"default": {
"name": "default",
"type": "globstring",
"basicInfo": "\"**\\*.#{options.language}\""
}
},
{
"lineNumber": 189,
"endLineNumber": 197,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This option tells the parser to attach arbitrary JSON to the external output. Useful if you have some arbitrary JSON files you want to display in your documentation."
},
"name": {
"name": "name",
"basicInfo": "json"
},
"category": {
"name": "category",
"basicInfo": "Option"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"default": {
"name": "default",
"type": "globstring",
"basicInfo": "\"\""
}
},
{
"lineNumber": 242,
"endLineNumber": 249,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This option allows specification of the order of tags when generating output.tree.json"
},
"name": {
"name": "name",
"basicInfo": "keySort"
},
"category": {
"name": "category",
"basicInfo": "Option"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"default": {
"name": "default",
"type": "array",
"basicInfo": "[]"
}
},
{
"lineNumber": 137,
"endLineNumber": 144,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This option determines what language to use."
},
"name": {
"name": "name",
"basicInfo": "language"
},
"category": {
"name": "category",
"basicInfo": "Option"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"default": {
"name": "default",
"type": "string",
"basicInfo": "\"coffee\""
}
},
{
"lineNumber": 210,
"endLineNumber": 218,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This option makes it so only the parser output is placed in the output directory. If both this and themeOnly are set to true, neither will output any data."
},
"name": {
"name": "name",
"basicInfo": "outputOnly"
},
"category": {
"name": "category",
"basicInfo": "Option"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"default": {
"name": "default",
"type": "boolean",
"basicInfo": "false"
}
},
{
"lineNumber": 200,
"endLineNumber": 207,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This option determines where the resulting theme and parser output should be put."
},
"name": {
"name": "name",
"basicInfo": "outputPath"
},
"category": {
"name": "category",
"basicInfo": "Option"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"default": {
"name": "default",
"type": "string",
"basicInfo": "\"doks\""
}
},
{
"lineNumber": 232,
"endLineNumber": 239,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This option allows for overriding template variables."
},
"name": {
"name": "name",
"basicInfo": "templateOptions"
},
"category": {
"name": "category",
"basicInfo": "Option"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"default": {
"name": "default",
"type": "object",
"basicInfo": "{}"
}
},
{
"lineNumber": 157,
"endLineNumber": 164,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This option determines which UI framework to use when choosing a theme."
},
"name": {
"name": "name",
"basicInfo": "theme"
},
"category": {
"name": "category",
"basicInfo": "Option"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"default": {
"name": "default",
"type": "string",
"basicInfo": "\"bootstrap-angular\""
}
},
{
"lineNumber": 221,
"endLineNumber": 229,
"filePath": "lib/parser.coffee",
"fileName": "parser.coffee",
"desc": {
"name": "desc",
"basicInfo": "This option makes it so only the theme is placed in the output directory. If both this and themeOnly are set to true, neither will output any data."
},
"name": {
"name": "name",
"basicInfo": "themeOnly"
},
"category": {
"name": "category",
"basicInfo": "Option"
},
"package": {
"name": "package",
"basicInfo": "TagParser"
},
"default": {
"name": "default",
"type": "boolean",
"basicInfo": "false"
}
}
]
}
]
}
],
"startTime": 1421981213604,
"endTime": 1421981213611,
"git": {
"short": "c07f0bd",
"long": "c07f0bd953e201fad25d2a935583f0c6f9ef2633",
"branch": "master",
"tag": "0.3.2"
}
}