utils.escape('<script></script>')\\n// => '<script></script>'\\nEscape the given html.
Escape the given html.
Output the given str to stdout.
Output the given str to stdout.
Output the given str to stdout
or the stream specified by options.
stream defaulting to stdoutmymodule.write(\\'foo\\')\\nmymodule.write(\\'foo\\', { stream: process.stderr })\\nOutput the given str to stdout
or the stream specified by options.
stream defaulting to stdoutmymodule.write(\\'foo\\')\\nmymodule.write(\\'foo\\', { stream: process.stderr })\\nstring|{ name: string, age: number|date }\",\n \"optional\": false,\n \"nullable\": false,\n \"nonNullable\": false,\n \"variable\": false\n },\n {\n \"type\": \"param\",\n \"string\": \"{{separator: string} =} options An options object\",\n \"name\": \"options\",\n \"description\": \"An options object\",\n \"types\": [\n {\n \"separator\": [\n \"string\"\n ]\n }\n ],\n \"typesDescription\": \"{ separator: string }|undefined\",\n \"optional\": true,\n \"nullable\": false,\n \"nonNullable\": false,\n \"variable\": false\n },\n {\n \"type\": \"return\",\n \"string\": \"{string} The constructed information string\",\n \"types\": [\n \"string\"\n ],\n \"typesDescription\": \"string\",\n \"optional\": false,\n \"nullable\": false,\n \"nonNullable\": false,\n \"variable\": false,\n \"description\": \"The constructed information string\"\n }\n ]\n```\n\n### Code\n\n The `.code` property is the code following the comment block, in our previous examples:\n\n```js\nexports.write = function(str, options) {\n options = options || {};\n (options.stream || process.stdout).write(str);\n return this;\n};\n```\n\n### Ctx\n\n The `.ctx` object indicates the context of the code block, is it a method, a function, a variable etc. Below are some examples:\n\n```js\nexports.write = function(str, options) {\n};\n```\n\nyields:\n\n```js\nctx:\n { type: 'method',\n receiver: 'exports',\n name: 'write',\n string: 'exports.write()' } }\n```\n\n```js\nvar foo = 'bar';\n```\n\nyields:\n\n```js\nctx:\n { type: 'declaration',\n name: 'foo',\n value: '\\'bar\\'',\n string: 'foo' }\n```\n\n```js\nfunction User() {\n\n}\n```\n\nyields:\n\n```js\nctx:\n { type: 'function',\n name: 'User',\n string: 'User()' } }\n```\n\n### Extending Context Matching\n\nContext matching in dox is done by performing pattern matching against the code following a\ncomment block. `dox.contextPatternMatchers` is an array of all pattern matching functions,\nwhich dox will iterate over until one of them returns a result. If none return a result,\nthen the comment block does not receive a `ctx` value.\n\nThis array is exposed to allow for extension of unsupported context patterns by adding more\nfunctions. Each function is passed the code following the comment block and (if detected)\nthe parent context if the block.\n\n```js\ndox.contextPatternMatchers.push(function (str, parentContext) {\n // return a context object if found\n // return false otherwise\n});\n```\n\n### Ignore\n\nComments and their associated bodies of code may be flagged with \"!\" to be considered worth ignoring, these are typically things like file comments containing copyright etc, however you of course can output them in your templates if you want.\n\n```\n/**\n * Not ignored.\n */\n```\n\nvs\n\n```\n/*!\n * Ignored.\n */\n```\n\nYou may use `-S`, `--skipSingleStar` or `{skipSingleStar: true}` to ignore `/* ... */` comments.\n\n### Running tests\n\n Install dev dependencies and execute `make test`:\n\n $ npm install -d\n $ make test\n\n## License\n\n(The MIT License)\n\nCopyright (c) 2011 TJ Holowaychuk <tj@vision-media.ca>\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","readmeFilename":"Readme.md","homepage":"https://github.com/tj/dox","contributors":[{"name":"Jocelyn Badgley","email":"joc@twipped.com"},{"name":"Arseny Zarechnev","email":"me@evindor.com"},{"name":"Thomas Parisot","email":"hi@oncletom.io"},{"name":"Stephen Mathieson","email":"me@stephenmathieson.com"},{"name":"Vladimir Tsvang","email":"vtsvang@gmail.com"},{"name":"Nathan Rajlich","email":"nathan@tootallnate.net"},{"name":"Gion Kunz","email":"gion.kunz@gmail.com"},{"name":"ForbesLindesay"}],"license":"MIT"}