mirror of
https://github.com/shaka-project/shaka-player.git
synced 2026-06-26 17:46:26 +03:00
Joey Parrish
395cc1745e
Also changes the jsdoc template for tutorials with children, to give the tutorial content itself control over how the links to children are formatted. Also fixes annotations for the TextParser interface. Change-Id: I99502f38bf711b74a596ad804d8abdddee5d6f4d
To create or use your own template:
- Create a folder with the same name as your template (for example,
mycooltemplate). - Within the template folder, create a file named
publish.js. This file must be a CommonJS module that exports a method namedpublish.
For example:
/** @module publish */
/**
* Generate documentation output.
*
* @param {TAFFY} data - A TaffyDB collection representing
* all the symbols documented in your code.
* @param {object} opts - An object with options information.
*/
exports.publish = function(data, opts) {
// do stuff here to generate your output files
};
To invoke JSDoc 3 with your own template, use the -t command line option, and specify the path to your template folder:
./jsdoc mycode.js -t /path/to/mycooltemplate