yuidoc-asp

{ "project": { "name": "yuidoc-root", "description": "YUIDoc, YUI's JavaScript Documentation engine.", "version": "0.6.0" }, "files": { "lib/builder.js": { "name": "lib/builder.js", "modules": {}, "classes": { "DocBuilder": 1 }, "fors": {}, "namespaces": {} }, "lib/cli.js": { "name": "lib/cli.js", "modules": {}, "classes": { "CLI": 1 }, "fors": {}, "namespaces": {} }, "lib/docparser.js": { "name": "lib/docparser.js", "modules": {}, "classes": { "DocParser": 1 }, "fors": { "DocParser": 1 }, "namespaces": {} }, "lib/docview.js": { "name": "lib/docview.js", "modules": {}, "classes": { "DocView": 1 }, "fors": {}, "namespaces": {} }, "lib/files.js": { "name": "lib/files.js", "modules": {}, "classes": { "Files": 1 }, "fors": {}, "namespaces": {} }, "lib/help.js": { "name": "lib/help.js", "modules": {}, "classes": { "Help": 1 }, "fors": {}, "namespaces": {} }, "lib/index.js": { "name": "lib/index.js", "modules": {}, "classes": { "Main": 1 }, "fors": {}, "namespaces": {} }, "lib/options.js": { "name": "lib/options.js", "modules": {}, "classes": { "Options": 1 }, "fors": {}, "namespaces": {} }, "lib/project.js": { "name": "lib/project.js", "modules": {}, "classes": {}, "fors": {}, "namespaces": {} }, "lib/server.js": { "name": "lib/server.js", "modules": {}, "classes": { "Server": 1 }, "fors": {}, "namespaces": {} }, "lib/utils.js": { "name": "lib/utils.js", "modules": {}, "classes": { "Utils": 1 }, "fors": {}, "namespaces": {} }, "lib/yuidoc.js": { "name": "lib/yuidoc.js", "modules": { "yuidoc": 1 }, "classes": { "YUIDoc": 1 }, "fors": { "YUIDoc": 1 }, "namespaces": {} } }, "modules": { "yuidoc": { "name": "yuidoc", "submodules": {}, "classes": { "DocBuilder": 1, "CLI": 1, "DocParser": 1, "DocView": 1, "Files": 1, "Help": 1, "Main": 1, "Options": 1, "Server": 1, "Utils": 1, "YUIDoc": 1 }, "fors": { "DocParser": 1, "YUIDoc": 1 }, "namespaces": {}, "tag": "main", "file": "lib/yuidoc.js", "line": 49, "description": "This is the __module__ description for the `YUIDoc` module.\n\n var options = {\n paths: [ './lib' ],\n outdir: './out'\n };\n\n var Y = require('yuidocjs');\n var json = (new Y.YUIDoc(options)).run();", "itemtype": "main" } }, "classes": { "DocBuilder": { "name": "DocBuilder", "shortname": "DocBuilder", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "yuidoc", "file": "lib/builder.js", "line": 12, "description": "Takes the `JSON` data from the `DocParser` class, creates and parses markdown and handlebars\nbased templates to generate static HTML content" }, "CLI": { "name": "CLI", "shortname": "CLI", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "yuidoc", "namespace": "", "file": "lib/cli.js", "line": 9, "description": "Parses the arguments, creates the options and passes them to `Y.YUIDoc` and then `Y.DocBuilder`." }, "DocParser": { "name": "DocParser", "shortname": "DocParser", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "yuidoc", "namespace": "", "file": "lib/docparser.js", "line": 749, "description": "The doc parser accepts a **map** of files to file content.\nOnce `parse()` is called, various properties will be populated\nwith the parsers data (aggregated in the `'data'` property).", "extends": "Base", "is_constructor": 1, "params": [ { "name": "o", "description": "the config object", "type": "Object" } ] }, "DocView": { "name": "DocView", "shortname": "DocView", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "yuidoc", "namespace": "", "file": "lib/docview.js", "line": 14, "description": "View class borrowed from [Selleck](https://github.com/rgrove/selleck) \nThe view class is a **`handlebars`** template helper.", "is_constructor": 1, "params": [ { "name": "data", "description": "Meta data to use in this template", "type": "Object" }, { "name": "templateName", "description": "The name of the template file to render.", "type": "String" } ] }, "Files": { "name": "Files", "shortname": "Files", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "yuidoc", "namespace": "", "file": "lib/files.js", "line": 8, "description": "Ported fileutils methods from [Selleck](http://github.com/rgrove/selleck)" }, "Help": { "name": "Help", "shortname": "Help", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "yuidoc", "namespace": "", "file": "lib/help.js", "line": 8, "description": "Shows the help text" }, "Main": { "name": "Main", "shortname": "Main", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "yuidoc", "namespace": "", "file": "lib/index.js", "line": 7, "description": "Module creates the YUI instance with the required modules, uses them and exports the **Y** to be used\nby the _CLI class_ or by extenders: `require('yuidocjs');` \nYou can use it like this: \n\n var options = {\n paths: [ './lib' ],\n outdir: './out'\n };\n\n var Y = require('yuidocjs');\n var json = (new Y.YUIDoc(options)).run();", "exports": "{YUI} Y A YUI instance" }, "Options": { "name": "Options", "shortname": "Options", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "yuidoc", "namespace": "", "file": "lib/options.js", "line": 10, "description": "Handles argument parsing" }, "Server": { "name": "Server", "shortname": "Server", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "yuidoc", "namespace": "", "file": "lib/server.js", "line": 9, "description": "Provides the `--server` server option for YUIDoc" }, "Utils": { "name": "Utils", "shortname": "Utils", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "yuidoc", "namespace": "", "file": "lib/utils.js", "line": 11, "description": "Utilities Class" }, "YUIDoc": { "name": "YUIDoc", "shortname": "YUIDoc", "classitems": [], "plugins": [], "extensions": [], "plugin_for": [], "extension_for": [], "module": "yuidoc", "namespace": "", "file": "lib/yuidoc.js", "line": 49, "description": "YUIDoc main class\n\n var options = {\n paths: [ './lib' ],\n outdir: './out'\n };\n\n var Y = require('yuidoc');\n var json = (new Y.YUIDoc(options)).run();", "mainName": "yuidoc", "tag": "main", "itemtype": "main", "_main": true, "is_constructor": 1, "params": [ { "name": "config", "description": "The config object" } ] } }, "classitems": [ { "file": "lib/builder.js", "line": 1, "description": "Copyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE", "class": "DocBuilder" }, { "file": "lib/builder.js", "line": 120, "description": "Register a `Y.Handlebars` helper method", "itemtype": "method", "name": "_addHelpers", "params": [ { "name": "helpers", "description": "Object containing a hash of names and functions", "type": "Object" } ], "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 137, "description": "Wrapper around the Markdown parser so it can be normalized or even side stepped", "itemtype": "method", "name": "markdown", "access": "private", "tagname": "", "params": [ { "name": "data", "description": "The Markdown string to parse", "type": "String" } ], "return": { "description": "The rendered HTML", "type": "HTML" }, "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 162, "description": "Parse the item to be cross linked and return an HREF linked to the item", "itemtype": "method", "name": "_parseCrossLink", "access": "private", "tagname": "", "params": [ { "name": "item", "description": "The item to crossLink", "type": "String" }, { "name": "raw", "description": "Do not wrap it in HTML", "type": "Boolean", "optional": true, "optdefault": "false" }, { "name": "content", "description": "crossLink helper content", "type": "String", "optional": true } ], "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 269, "description": "List of native types to cross link to MDN", "itemtype": "property", "name": "NATIVES", "type": "Object", "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 308, "description": "Function to link an external type uses `NATIVES` object", "itemtype": "method", "name": "NATIVES_LINKER", "access": "private", "tagname": "", "params": [ { "name": "name", "description": "The name of the type to link", "type": "String" } ], "return": { "description": "The combined URL", "type": "String" }, "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 322, "description": "Mixes the various external data soures together into the local data, augmenting\nit with flags.", "itemtype": "method", "name": "_mixExternal", "access": "private", "tagname": "", "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 370, "description": "Fetches the remote data and fires the callback when it's all complete", "itemtype": "method", "name": "mixExternal", "params": [ { "name": "cb", "description": "The callback to execute when complete", "type": "Callback" } ], "async": 1, "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 445, "description": "File counter", "itemtype": "property", "name": "files", "type": "Number", "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 451, "description": "Holder for project meta data", "itemtype": "property", "name": "_meta", "type": "Object", "access": "private", "tagname": "", "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 458, "description": "Prep the meta data to be fed to Selleck", "itemtype": "method", "name": "getProjectMeta", "return": { "description": "The project metadata", "type": "Object" }, "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 501, "description": "Populate the meta data for classes", "itemtype": "method", "name": "populateClasses", "params": [ { "name": "opts", "description": "The original options", "type": "Object" } ], "return": { "description": "The modified options", "type": "Object" }, "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 525, "description": "Populate the meta data for modules", "itemtype": "method", "name": "populateModules", "params": [ { "name": "opts", "description": "The original options", "type": "Object" } ], "return": { "description": "The modified options", "type": "Object" }, "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 571, "description": "Populate the meta data for files", "itemtype": "method", "name": "populateFiles", "params": [ { "name": "opts", "description": "The original options", "type": "Object" } ], "return": { "description": "The modified options", "type": "Object" }, "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 628, "description": "Parses file and line number from an item object and build's an HREF", "itemtype": "method", "name": "addFoundAt", "params": [ { "name": "a", "description": "The item to parse", "type": "Object" } ], "return": { "description": "The parsed HREF", "type": "String" }, "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 644, "description": "Augments the **DocParser** meta data to provide default values for certain keys as well as parses all descriptions\nwith the `Markdown Parser`", "itemtype": "method", "name": "augmentData", "params": [ { "name": "o", "description": "The object to recurse and augment", "type": "Object" } ], "return": { "description": "The augmented object", "type": "Object" }, "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 705, "description": "Makes the default directories needed", "itemtype": "method", "name": "makeDirs", "params": [ { "name": "cb", "description": "The callback to execute after it's completed", "type": "Callback" } ], "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 758, "description": "Parses `<pre><code>` tags and adds the __prettyprint__ `className` to them", "itemtype": "method", "name": "_parseCode", "access": "private", "tagname": "", "params": [ { "name": "html", "description": "The HTML to parse", "type": "HTML" } ], "return": { "description": "The parsed HTML", "type": "HTML" }, "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 771, "description": "Ported from [Selleck](https://github.com/rgrove/selleck), this handles ```'s in fields\n that are not parsed by the **Markdown** parser.", "itemtype": "method", "name": "_inlineCode", "access": "private", "tagname": "", "params": [ { "name": "html", "description": "The HTML to parse", "type": "HTML" } ], "return": { "description": "The parsed HTML", "type": "HTML" }, "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 790, "description": "Ported from [Selleck](https://github.com/rgrove/selleck)\n Renders the handlebars templates with the default View class.", "itemtype": "method", "name": "render", "params": [ { "name": "source", "description": "The default template to parse", "type": "HTML" }, { "name": "view", "description": "The default view handler", "type": "Class" }, { "name": "layout", "description": "The HTML from the layout to use.", "type": "HTML", "optional": true, "optdefault": "null" }, { "name": "partials", "description": "List of partials to include in this template", "type": "Object", "optional": true, "optdefault": "{}" }, { "name": "callback", "description": "", "type": "Callback", "props": [ { "name": "err", "description": "", "type": "Error" }, { "name": "html", "description": "The assembled template markup", "type": "HTML" } ] } ], "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 846, "description": "Render the index file", "itemtype": "method", "name": "renderIndex", "params": [ { "name": "cb", "description": "The callback fired when complete", "type": "Function", "props": [ { "name": "html", "description": "The HTML to render this view", "type": "String" }, { "name": "view", "description": "The View Data", "type": "Object" } ] } ], "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 871, "description": "Generates the index.html file", "itemtype": "method", "name": "writeIndex", "params": [ { "name": "cb", "description": "The callback to execute after it's completed", "type": "Callback", "props": [ { "name": "html", "description": "The HTML to write index view", "type": "String" }, { "name": "view", "description": "The View Data", "type": "Object" } ] } ], "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 897, "description": "Render a module", "itemtype": "method", "name": "renderModule", "params": [ { "name": "cb", "description": "The callback fired when complete", "type": "Function", "props": [ { "name": "html", "description": "The HTML to render this view", "type": "String" }, { "name": "view", "description": "The View Data", "type": "Object" } ] } ], "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 981, "description": "Generates the module files under \"out\"/modules/", "itemtype": "method", "name": "writeModules", "params": [ { "name": "cb", "description": "The callback to execute after it's completed", "type": "Callback", "props": [ { "name": "html", "description": "The HTML to write module view", "type": "String" }, { "name": "view", "description": "The View Data", "type": "Object" } ] } ], "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 1024, "description": "Checks an array of items (class items) to see if an item is in that list", "itemtype": "method", "name": "hasProperty", "params": [ { "name": "a", "description": "The Array of items to check", "type": "Array" }, { "name": "b", "description": "The object to find", "type": "Object" } ], "return": { "description": "Boolean" }, "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 1041, "description": "Counter for stepping into merges", "access": "private", "tagname": "", "itemtype": "property", "name": "_mergeCounter", "type": "Number", "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 1048, "description": "Merge superclass data into a child class", "itemtype": "method", "name": "mergeExtends", "params": [ { "name": "info", "description": "The item to extend", "type": "Object" }, { "name": "classItems", "description": "The list of items to merge in", "type": "Array" }, { "name": "first", "description": "Set for the first call", "type": "Boolean" } ], "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 1100, "description": "Render the class file", "itemtype": "method", "name": "renderClass", "params": [ { "name": "cb", "description": "The callback fired when complete", "type": "Function", "props": [ { "name": "html", "description": "The HTML to render this view", "type": "String" }, { "name": "view", "description": "The View Data", "type": "Object" } ] } ], "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 1388, "description": "Generates the class files under \"out\"/classes/", "itemtype": "method", "name": "writeClasses", "params": [ { "name": "cb", "description": "The callback to execute after it's completed", "type": "Callback", "props": [ { "name": "html", "description": "The HTML to write class view", "type": "String" }, { "name": "view", "description": "The View Data", "type": "Object" } ] } ], "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 1431, "description": "Sort method of array of objects with a property called __name__", "itemtype": "method", "name": "nameSort", "params": [ { "name": "a", "description": "First object to compare", "type": "Object" }, { "name": "b", "description": "Second object to compare", "type": "Object" } ], "return": { "description": "1, -1 or 0 for sorting.", "type": "Number" }, "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 1454, "description": "Generates the syntax files under `\"out\"/files/`", "itemtype": "method", "name": "writeFiles", "params": [ { "name": "cb", "description": "The callback to execute after it's completed", "type": "Callback", "props": [ { "name": "html", "description": "The HTML to write file view", "type": "String" }, { "name": "view", "description": "The View Data", "type": "Object" } ] } ], "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 1504, "description": "Render the source file", "itemtype": "method", "name": "renderFile", "params": [ { "name": "cb", "description": "The callback fired when complete", "type": "Function", "props": [ { "name": "html", "description": "The HTML to render this view", "type": "String" }, { "name": "view", "description": "The View Data", "type": "Object" } ] } ], "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 1558, "description": "Write the API meta data used for the AutoComplete widget", "itemtype": "method", "name": "writeAPIMeta", "params": [ { "name": "cb", "description": "The callback to execute when complete", "type": "Callback" } ], "async": 1, "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 1571, "description": "Render the API meta and return the JavaScript", "itemtype": "method", "name": "renderAPIMeta", "params": [ { "name": "cb", "description": "The callback", "type": "Callback", "props": [ { "name": "apijs", "description": "The JavaScript code to write API meta data", "type": "String" } ] } ], "async": 1, "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 1604, "description": "Normalizes a file path to a writable filename:\n\n var path = 'lib/file.js';\n returns 'lib_file.js';", "itemtype": "method", "name": "filterFileName", "params": [ { "name": "f", "description": "The filename to normalize", "type": "String" } ], "return": { "description": "The filtered file path", "type": "String" }, "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/builder.js", "line": 1617, "description": "Compiles the templates from the meta-data provided by DocParser", "itemtype": "method", "name": "compile", "params": [ { "name": "cb", "description": "The callback to execute after it's completed", "type": "Callback" } ], "class": "DocBuilder", "module": "yuidoc" }, { "file": "lib/cli.js", "line": 3, "description": "Copyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE", "class": "CLI", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 1, "description": "Copyright (c) 2011, Yahoo! Inc. All rights reserved.\nCode licensed under the BSD License:\nhttps://github.com/yui/yuidoc/blob/master/LICENSE", "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 11, "description": "Parses the JSON data and formats it into a nice log string for\nfilename and line number: `/file/name.js:123`", "itemtype": "method", "name": "stringlog", "access": "private", "tagname": "", "params": [ { "name": "data", "description": "The data block from the parser", "type": "Object" } ], "return": { "description": "The formatted string.", "type": "String" }, "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 38, "description": "Flatten a string, remove all line breaks and replace them with a token", "itemtype": "method", "name": "implodeString", "access": "private", "tagname": "", "params": [ { "name": "str", "description": "The string to operate on", "type": "String" } ], "return": { "description": "The modified string", "type": "String" }, "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 48, "description": "Un-flatten a string, replace tokens injected with `implodeString`", "itemtype": "method", "name": "implodeString", "access": "private", "tagname": "", "params": [ { "name": "str", "description": "The string to operate on", "type": "String" } ], "return": { "description": "The modified string", "type": "String" }, "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 94, "description": "A list of known tags. This populates a member variable\nduring initialization, and will be updated if additional\ndigesters are added.", "itemtype": "property", "name": "TAGLIST", "type": "Array", "final": 1, "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 174, "description": "A list of ignored tags. These tags should be ignored because there is\nlikely to be used for purposes other than JSDoc tags in JavaScript comments.", "itemtype": "property", "name": "IGNORE_TAGLIST", "type": "Array", "final": 1, "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 186, "description": "Common errors will get scrubbed instead of being ignored.", "itemtype": "property", "name": "CORRECTIONS", "type": "Object", "final": 1, "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 209, "description": "A map of the default tag processors, keyed by the\ntag name. Multiple tags can use the same digester\nby supplying the string name that points to the\nimplementation rather than a function.", "itemtype": "property", "name": "DIGESTERS", "type": "Object", "final": 1, "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 777, "description": "Digesters process the tag/text pairs found in a\ncomment block. They are looked up by tag name.\nThe digester gets the tagname, the value, the\ntarget object to apply values to, and the full\nblock that is being processed. Digesters can\nbe declared as strings instead of a function --\nin that case, the program will try to look up\nthe key listed and use the function there instead\n(it is an alias). Digesters can return a host\nobject in the case the tag defines a new key\nblock type (modules/classes/methods/events/properties)", "itemtype": "attribute", "name": "digesters", "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 799, "description": "Emitters will be schemas for the types of payloads\nthe parser will emit. Not implemented.", "itemtype": "attribute", "name": "emitters", "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 810, "description": "Comment syntax type.", "itemtype": "attribute", "name": "syntaxtype", "type": "String", "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 819, "description": "The map of file names to file content.", "itemtype": "attribute", "name": "filemap", "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 827, "description": "A map of file names to directory name. Provided in\ncase this needs to be used to reset the module name\nappropriately -- currently not used", "itemtype": "attribute", "name": "dirmap", "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 837, "description": "The file currently being parsed", "itemtype": "attribute", "name": "currentfile", "type": "String", "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 858, "description": "The main documentation block for the module itself.", "itemtype": "attribute", "name": "mainmodule", "type": "String", "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 894, "description": "The module currently being parsed", "itemtype": "attribute", "name": "currentmodule", "type": "String", "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 953, "description": "The submodule currently being parsed", "itemtype": "attribute", "name": "currentsubmodule", "type": "String", "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 993, "description": "The class currently being parsed", "itemtype": "attribute", "name": "currentclass", "type": "String", "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 1033, "description": "Takes a non-namespaced classname and resolves it to a namespace (to support `@for`)", "access": "private", "tagname": "", "itemtype": "method", "name": "_resolveFor", "params": [ { "name": "value", "description": "The classname to resolve", "type": "String" } ], "return": { "description": "The resolved namespace + classname", "type": "String" }, "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 1107, "description": "Normalizes the initial indentation of the given _content_ so that the first line\nis unindented, and all other lines are unindented to the same degree as the\nfirst line. So if the first line has four spaces at the beginning, then all\nlines will be unindented four spaces. Ported from [Selleck](https://github.com/rgrove/selleck)", "itemtype": "method", "name": "unindent", "params": [ { "name": "content", "description": "Text to unindent.", "type": "String" } ], "return": { "description": "Unindented text.", "type": "String" }, "access": "private", "tagname": "", "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 1128, "description": "Transforms a JavaDoc style comment block (less the start and end of it)\ninto a list of tag/text pairs. The leading space and '*' are removed,\nbut the remaining whitespace is preserved so that the output should be\nfriendly for both markdown and html parsers.", "itemtype": "method", "name": "handlecomment", "params": [ { "name": "comment", "description": "The comment to parse", "type": "String" }, { "name": "file", "description": "The file it was parsed from", "type": "String" }, { "name": "line", "description": "The line number it was found on", "type": "String" } ], "class": "DocParser", "module": "yuidoc" }, { "file": "lib/docparser.js", "line": 1206, "description": "Accepts a map of filenames to file content. Returns\na map of filenames to an array of API comment block\ntext. This expects the comment to start with / **\non its own line, and end with * / on its own\nline. Override this function to provide an\nalternative comment parser.", "itemtype": "method", "name": "extract", "params": [ { "name": "filemap", "description": "A map of filenames to file content", "type": "Object" }, { "name": "dirmap", "description": "A map of file