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

github.com/fireball-x/firedoc

fireball-x/firedoc

637 lines (635 loc) • 21.3 kB

HTML

<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/context.js</title> <meta charset="utf-8"> <link rel="stylesheet" href="../prettify.css"> <link rel="stylesheet" href="../base.css"> <style type='text/css'> div.coverage-summary .sorter { background-image: url(../sort-arrow-sprite.png); } </style> </head> <body> <div class="header low"> <h1>Code coverage report for lib/context.js</h1> <h2> Statements: 9.33% (7 / 75)      Branches: 0% (0 / 40)      Functions: 0% (0 / 11)      Lines: 9.46% (7 / 74)      Ignored: none      </h2> <div class="path"><a href="../index.html">All files</a> » <a href="index.html">lib/</a> » context.js</div> </div> <div class="body"> <pre><table class="coverage"> <tr><td class="line-count">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198</td><td class="line-coverage">            1 1 1 1 1             1                                                                                                                                                                                                                                                                                                                                                                     1  </td><td class="text"><pre class="prettyprint lang-js">  /** * The firedoc module * @module firedoc */   const _ = require('underscore'); const path = require('path'); const utils = require('./utils'); const debug = require('debug')('firedoc:context'); const AST = require('./ast').AST;   /** * The ParserContext * * @class ParserContext */ var ParserContext = { /** * @property {Any} file - The file */ get file () { return this._file; }, set file (val) { val = utils.safetrim(val); if (!_.has(this.ast.files, val)) { this.ast.files[val] = { 'name': val, 'classes': {}, 'modules': {}, 'fors': {}, 'namespaces': {}, 'code': this.ast.codes[val] }; } this._file = val; },   /** * @property {Any} mainModule */ get mainModule () { return this._mainModule; }, set mainModule (val) { if (!val) { return; } else { this._mainModule = val; } var write = true; var name = val.mainName || val.name; if (this.module === name) { if (_.has(this.ast.modules, name)) { if (this.ast.modules[name].tag === 'main') { write = false; } if (write) { this.ast.modules[name] = _.extend(this.ast.modules[name], val); } } else { if (val._main) { this.ast.modules[name] = val; } } } },   /** * @property {Any} module */ get module () { return this._module; }, set module (val) { var last = {}; if (!val) { return; } else { last.module = this.ast.modules[this.module]; last.clazz = this.ast.classes[this.clazz]; val = utils.safetrim(val); this._module = val; this._clazz = ''; } this.submodule = '';   var main = this.mainModule; if (main && main.name !== val) { this.mainModule = ''; }   if (last.clazz && last.clazz.module !== val) { last.module.classes[last.clazz.name] = last.clazz; if (this.ast.modules[last.clazz.submodule]) { this.ast.modules[last.clazz.submodule].module = last.module.name; } }   if (!_.has(this.ast.modules, val)) { this.ast.modules[val] = { 'name': val, 'namespace': val, 'type': 'modules', 'classes': {}, 'submodules': {}, 'fors': {}, 'namespaces': {}, 'types': {} }; } },   /** * @property {Any} process */ get clazz () { return this._clazz; }, set clazz (val) { if (!val) { return; } else { val = utils.safetrim(val); this._clazz = val; } var clazz; var name = val; if (!_.has(this.ast.classes, val)) { clazz = { 'name': name, 'type': 'classes', 'shortname': val, 'members': [], 'plugins': [], 'pluginFor': [], 'extensions': [], 'types': {} }; clazz.module = this.module; clazz.submodule = this.submodule || null; clazz.namespace = utils.getNamespace(this); this.ast.classes[name] = clazz; } },   /** * @property {Any} submodule */ get submodule () { return this._submodule; }, set submodule (val) { if (!val) return; val = utils.safetrim(val);   if (!_.has(this.ast.modules, val)) { var mod = { 'name': val, 'type': 'modules', 'classes': {}, 'submodules': {}, 'fors': {}, 'isSubmodule': true, 'namespaces': {}, 'types': {} }; mod.module = this.module; mod.namespace = utils.getNamespace(mod); this.ast.modules[val] = mod; } this._submodule = val; },   /** * @property {Any} block */ block: null,   /** * reset the context * @method reset */ reset: function () { this._file = null; this._mainModule = null; this._main = null; this._module = null; this._clazz = null; this._submodule = null; this.block = null; }   };   exports.ParserContext = ParserContext;  </pre></td></tr> </table></pre> </div> <div class="footer"> <div class="meta">Generated by <a href="http://istanbul-js.org/" target="_blank">istanbul</a> at Thu Jul 02 2015 15:00:46 GMT+0800 (CST)</div> </div> <script src="../prettify.js"></script> <script> window.onload = function () { if (typeof prettyPrint === 'function') { prettyPrint(); } }; </script> <script src="../sorter.js"></script> </body> </html>