firedoc
Version:
API Doc generator rewritten from [YUIDoc](https://github.com/yui/yuidoc). We use this tool to document a large JavaScript game engine [Fireball](http://github.com/fireball-x/fireball) at [docs-zh.fireball-x.com/api](http://docs-zh.fireball-x.com/api/) and
72 lines • 3.9 kB
JSON
{
"project": {
"assets": "assets"
},
"files": [
{
"name": "test_targets_members_index.js",
"classes": {},
"modules": {},
"fors": {},
"namespaces": {},
"code": "\n/**\n * This module is used to test members\n *\n * @module testmembers\n */\n\n/**\n * common callback\n * @callback commoncall\n * @param {Error} err - The error as first argument\n * @param {Object} obj - The returned object\n */\n\n/**\n * example method\n * @method example_optional\n * @param {Number} [x=10] The default value is 10(test)\n * @param {Object} [y=object]\n * @param {Array} [z=array]\n * @param {commoncall} callback\n * @constructor\n * @return {Number}\n * @example\n * ```\n * example\n * ```\n */\n\n/**\n * example method 2\n * @method example_sub_params\n * @param {Object} o\n * @param {Number} o.x\n * @param {Object} [o.y=object]\n * @param {Boolean} o.y.a\n * @public\n * @return {Number}\n * @example {@link test/examples/ex0.js}\n * @example {@link test/examples/ex1.js}\n */\n\n/**\n * const test\n * @property const_property\n * @const\n * @deprecated this is just deprecated\n */\n\n/**\n * markdown link in method parameter description\n * @method md_link_in_method_params_desc\n * @param {Object} [webContents] - A [WebContents](https://github.com/atom/electron/blob/master/docs/api/browser-window.md#class-webcontents) object\n */\n\n/**\n * html example\n * @method html_example\n * @example\n * ```\n * // index.html\n * <html>\n * <body>\n * <script>\n * require('ipc').on('foo:bar', function(message) {\n * console.log(message); // Prints \"Hello World!\"\n * });\n * require(\"look\");\n * </script>\n * </body>\n * </html>\n */\n\n",
"i18n": {
"sidebar": {
"CLASSES": "Classes",
"MODULES": "Modules",
"ENUMS": "Enums",
"SEARCH_PLACEHOLDER": "Type to filter APIs"
},
"options": {
"SHOW": "Show",
"PROTECTED": "Protected",
"PRIVATE": "Private",
"DEPRECATED": "Deprecated"
},
"INDEX_WELCOME": "Browse to a module or class using the sidebar to view its API documentation.",
"INDEX_TITLE": "Keyboard Shortcuts",
"INDEX_GUIDES_1": "ress <kbd>s</kbd> to focus the API search box.",
"INDEX_GUIDES_2": "Use <kbd>Up</kbd> and <kbd>Down</kbd> to select classes, modules, and search results.",
"INDEX_GUIDES_3": "With the API search box or sidebar focused, use <kbd><span class='cmd'>⌘</span>-Left</kbd> or <kbd><span class='cmd'>⌘</span>-Right</kbd> to switch sidebar tabs.",
"INDEX_GUIDES_4": "With the API search box or sidebar focused, use <kbd>Ctrl+Left</kbd> and <kbd>Ctrl+Right</kbd> to switch sidebar tabs.",
"INDEX": "Index",
"STATIC": "static",
"DEPRECATED": "deprecated",
"CHAINABLE": "chainable",
"ASYNC": "async",
"OPTIONAL": "optional",
"DEFAULTS": "default",
"EXAMPLES": "examples",
"PARAMETERS": "parameters",
"RETURNS": "returns",
"TYPE": "type",
"CLASS": "Class",
"MODULE": "Module",
"ENUM": "Enum",
"PARENT_MODULE": "Parent Module",
"PROPERTIES": "Properties",
"ATTRUBUTES": "Attributes",
"METHODS": "Methods",
"EVENTS": "Events",
"INHERITED_MEMBERS": "inherited members",
"INHERITANCE_TREE": "Inheritance Tree",
"CONSTRUCTOR": "Constructor",
"DEFINED_IN": "Defined in",
"EXTENDS_FOR": "Extends",
"INHERITED_FROM": "Inherited from",
"LANG": "en",
"foundAt": ""
},
"path": "test_targets_members_index.js"
}
],
"enums": [],
"classes": [],
"modules": [
{
"name": "testmembers",
"namespace": "testmembers",
"description": "<p>This module is used to test members</p>\n"
}
]
}