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

277 lines (275 loc) • 9.38 kB

HTML

<!doctype html> <html lang="en"> <head> <title>Code coverage report for lib/docview.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/docview.js</h1> <h2> Statements: 19.35% (6 / 31)      Branches: 0% (0 / 14)      Functions: 0% (0 / 4)      Lines: 19.35% (6 / 31)      Ignored: none      </h2> <div class="path"><a href="../index.html">All files</a> » <a href="index.html">lib/</a> » docview.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</td><td class="line-coverage">              1 1 1                     1                                   1                                                                           1  </td><td class="text"><pre class="prettyprint lang-js">/* global YUI */   /** * The firedoc module * @module firedoc */   const _ = require('underscore'); const path = require('path'); const Handlebars = require('handlebars');   /** * View class borrowed from [Selleck](https://github.com/rgrove/selleck) * The view class is a **`handlebars`** template helper. * * @class DocView * @constructor * @param {Object} data Meta data to use in this template * @param {String} templateName The name of the template file to render. **/ function DocView (data, templateName, cwd) { this.templateName = templateName; this.cwd = path.join(cwd || ''); this.assets = path.join(cwd || '', 'assets'); _.extend(this, data);   // register helpers var self = this; Handlebars.registerHelper('relink', function (item, options) { item = item || ''; if (self.project.local) { return '//' + self.project.root + '/' + item; } else { return self.project.baseurl + '/' + item; } }); }   DocView.prototype = { /** * **Mustache** `lambda` method for setting the HTML title * @method htmlTitle */ htmlTitle: function () { var name = this.name; var title = name; try { if (title) { if (this.project.name) { title += ' - ' + this.project.name; } } else { title = this.project.name; } } catch (e) {} return title; },   /** * **Mustache** `lambda` method for setting the title * @method title */ title: function () { var name = this.name; var title = name; try { title = this.project.name; if (name) { title += ': ' + name; } } catch (e) {} return title; }   };   exports.DocView = DocView;  </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>