/** * Generates Markdown from JSDoc entries in a given file. * * @param {Array} [$options=array()] The options array. * @returns {string} The generated Markdown. * @example * * // specify a file path * $markdown = docdown(array( * // path to js file * 'path' => $filepath, * // url used to reference line numbers in code * 'url' => 'https://github.com/username/project/blob/master/my.js' * )); * * // or pass raw js * $markdown = docdown(array( * // raw JavaScript source * 'source' => $rawJS, * // documentation title * 'title' => 'My API Documentation', * // url used to reference line numbers in code * 'url' => 'https://github.com/username/project/blob/master/my.js' * )); */ function docdown($options = array()) { $gen = new MarkdownGenerator($options); return $gen->generate(); }