markdox/examples/fixtures/small-parser.js

Markdox is a documentation generator based on Dox and Markdown with support for JavaScript, CoffeeScript and IcedCoffeeScript.

/**
 * # The small parser
 * 
 * This is a small parser.
 *
 *     var parser = require('small-parser')
 */


/*!
 * Library version.
 * 
 * @type {String}
 * @api public
 */

exports.version = '0.0.1';

/**
 * Parse the given `str`.
 *
 * Examples:
 *
 *     parse(str)
 *     // => "wahoo"
 *
 * @param {String|Buffer} str String to parse
 * @return {String} Persed string
 * @api public
 */

exports.parse = function(str) {
  return "wahoo";
}