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

1,566 lines • 74 kB

HTML

<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/locals.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/locals.js</h1> <h2> Statements: 2.8% (8 / 286)      Branches: 0% (0 / 185)      Functions: 0% (0 / 43)      Lines: 2.84% (8 / 282)      Ignored: none      </h2> <div class="path"><a href="../index.html">All files</a> » <a href="index.html">lib/</a> » locals.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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641</td><td class="line-coverage">            1 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:local'); const MarkdownIt = require('markdown-it'); const md = new MarkdownIt();   /** * The Theme Locals * @class Locals * @main Locals */ var Locals = {   /** * @property {BuilderContext} context - Builder Context */ context: null,   /** * @property {Option} options - The options */ options: {},   /** * @property {AST} ast - The AST object */ ast: {},   /** * @property {Object} project - Get the project to export */ get project () { var root; if (path.isAbsolute(this.options.dest)) { root = this.options.dest; } else { root = path.join(process.cwd(), this.options.dest || ''); } var proj = this.ast.project; proj.root = root; proj.base = this.options.http ? '' : proj.root; proj.assets = path.join(root, '/assets'); return proj; },   /** * @property {Object} i18n - Get i18n object */ get i18n () { try { var defaults = require(this.options.theme + '/i18n/en.json'); var extra = {}; if (this.options.lang) { extra = require(this.options.theme + '/i18n/' + this.options.lang + '.json'); } var ret = _.extend(defaults, extra); ret.LANG = this.options.lang || 'en'; return ret; } catch (e) { return {}; } },   /** * @property {Object} modules - Get modules object to export */ get modules () { var self = this; return Object.keys(self.ast.modules).map( function (name) { var mod = self.ast.modules[name]; mod = self.context.addFoundAt(mod); mod.description = self.parseCode(self.markdown(mod.description)); mod.members = mod.members || []; mod.project = self.project; mod.globals = self; mod.i18n = self.i18n; return mod; } ); },   /** * @property {Object} classes - Get classes object to export */ get classes () { var self = this; return Object.keys(self.ast.classes).map( function (name) { var clazz = self.ast.classes[name]; clazz = self.context.addFoundAt(clazz); clazz = self.appendClassToModule(clazz); clazz.description = self.parseCode(self.markdown(clazz.description)); clazz.members = clazz.members || []; clazz.project = self.project; clazz.globals = self; clazz.i18n = self.i18n; clazz.inheritance = self.getInheritanceTree(clazz); if (clazz.isConstructor) { clazz.constructor = self.buildMember(clazz, true); } return clazz; } ); },   /** * @property {Object} files - Get files object to export */ get files () { var self = this; return Object.keys(self.ast.files).map( function (name) { var file = self.ast.files[name]; file.i18n = self.i18n; return file; } ); },   /** * Initialize the markdownit rulers * @method initMarkdownRulers */ initMarkdownRulers: function () { var ast = this.ast; var options = this.options; md.renderer.rules.link_open = function (tokens, idx, ops, env, self) { var token = tokens[idx]; if (token && _.isArray(token.attrs)) { token.attrs = token.attrs.map(function (attr, idx) { if (attr[0] === 'href' && /^https?:\/\//.test(attr[1]) === false) { var target = ast.namespacesMap[attr[1]]; var ext = options.markdown ? '.md' : '.html'; if (target.parent && target.itemtype) { var url = target.parent.type + '/' + target.parent.name + ext + '#' + target.itemtype + '_' + target.name; attr[1] = url; } } return attr; }); } return self.renderToken(tokens, idx, options); }; },   /** * Parses file and line number from an item object and build's an HREF * @method addFoundAt * @param {Object} a The item to parse * @return {String} The parsed HREF */ addFoundAt: function (a) { var self = this; var ext = this.options.markdown ? '.md' : '.html'; if (a.file && a.line && !this.options.nocode) { a.foundAt = '../files/' + utils.filterFileName(a.file) + ext + '#l' + a.line; if (a.path) { a.foundAt = a.path + '#l' + a.line; } } return a; },   /** * build the method name by its name and parameters * * @method getMethodName * @param {String} name - The function/method name * @param {Array} params - The function/method parameters list * @param {String} params.name - The name of the parameter */ getMethodName: function (name, params) { return name + '(' + (params || []).map(function (v) { return v.name; }).join(', ') + ')'; },   /** * Parses `<pre><code>` tags and adds the __prettyprint__ `className` to them * @method _parseCode * @private * @param {HTML} html The HTML to parse * @return {HTML} The parsed HTML */ parseCode: function (html) { html = html || ''; html = html.replace(/<pre><code>/g, '<pre class="code prettyprint"><code>\n'); // TODO(Yorkie): request to underscore, this is not working with &#39; html = html.replace(/&#39;/g, '\''); return _.unescape(html); },   /** * Wrapper around the Markdown parser so it can be normalized or even side stepped * @method markdown * @private * @param {String} data The Markdown string to parse * @return {HTML} The rendered HTML */ markdown: function (data) { var self = this; if (this.options.markdown) { return data; } var html = md.render(data || ''); //Only reprocess if helpers were asked for if (this.options.helpers || (html.indexOf('{{#crossLink') > -1)) { try { // markdown-it auto-escapes quotation marks (and unfortunately // does not expose the escaping function) html = html.replace(/&quot;/g, "\""); html = (Handlebars.compile(html))({}); } catch (hError) { //Remove all the extra escapes html = html.replace(/\\{/g, '{').replace(/\\}/g, '}'); console.warn('Failed to parse Handlebars, probably an unknown helper, skiped'); } } return html; },   /** * append the clazz to its module * * @method appendClassToModule * @param {Object} clazz - The class object * @param {String} clazz.module - The module name of this clazz object */ appendClassToModule: function (clazz) { var mod = this.ast.modules[clazz.module]; if (mod) { if (!_.isArray(mod.classes)) mod.classes = []; mod.classes.push(clazz); } return clazz; },   /** * get class inheritance tree * * @method getClassInheritanceTree * @return {Object} return the inheritance tree object */ getInheritanceTree: function (clazz) { var children = []; this.ast.inheritedMembers.forEach(function (inherit) { var at = inherit.indexOf(clazz.name); if (at > -1 && at < inherit.length) { <span class="cstat-n