node-query/node_modules/grunt-jsdoc/node_modules/jsdoc/lib/jsdoc
Timothy Warren 6542c8f674 A bunch of random progress 2014-10-20 16:56:45 -04:00
..
opts A bunch of random progress 2014-10-20 16:56:45 -04:00
src A bunch of random progress 2014-10-20 16:56:45 -04:00
tag A bunch of random progress 2014-10-20 16:56:45 -04:00
tutorial A bunch of random progress 2014-10-20 16:56:45 -04:00
util A bunch of random progress 2014-10-20 16:56:45 -04:00
augment.js A bunch of random progress 2014-10-20 16:56:45 -04:00
borrow.js A bunch of random progress 2014-10-20 16:56:45 -04:00
config.js A bunch of random progress 2014-10-20 16:56:45 -04:00
doclet.js A bunch of random progress 2014-10-20 16:56:45 -04:00
fs.js A bunch of random progress 2014-10-20 16:56:45 -04:00
name.js A bunch of random progress 2014-10-20 16:56:45 -04:00
package.js A bunch of random progress 2014-10-20 16:56:45 -04:00
path.js A bunch of random progress 2014-10-20 16:56:45 -04:00
plugins.js A bunch of random progress 2014-10-20 16:56:45 -04:00
readme.js A bunch of random progress 2014-10-20 16:56:45 -04:00
schema.js A bunch of random progress 2014-10-20 16:56:45 -04:00
tag.js A bunch of random progress 2014-10-20 16:56:45 -04:00
template.js A bunch of random progress 2014-10-20 16:56:45 -04:00
tutorial.js A bunch of random progress 2014-10-20 16:56:45 -04:00

readme.js

/*global env: true */

/**
 * Make the contents of a README file available to include in the output.
 * @module jsdoc/readme
 * @author Michael Mathews <micmath@gmail.com>
 * @author Ben Blank <ben.blank@gmail.com>
 */
'use strict';

var fs = require('jsdoc/fs'),
    markdown = require('jsdoc/util/markdown');

/**
 * @class
 * @classdesc Represents a README file.
 * @param {string} path - The filepath to the README.
 */
function ReadMe(path) {
    var content = fs.readFileSync(path, env.opts.encoding),
        parse = markdown.getParser();

    this.html = parse(content);
}

module.exports = ReadMe;