Generates a DocSet from JSDoc documentation. This DocSet can be used with the Dasp App.
{
"docSetRoot": "/path/to/docset/output",
"docSetName": "MyDocSetJs",
"docSetIdentifier": "MyDocSet",
"docSetPlatformFamily": "MyDocSet",
"icon": "/path/to/my/icon.png",
"documentation": "/path/to/jsdoc/output"
}
var JsdocDocsetGenerator = require('jsdoc-docset-generator'),
var generator = new JsdocDocsetGenerator(
{
'documentation': '/path/to/jsdoc/output',
'docSetRoot': '/path/to/docset/output',
'docSetName': 'MyDocSetJs',
'docSetIdentifier': 'MyDocSet',
'docSetPlatformFamily': 'MyDocSet',
'icon': '/path/to/my/icon.png'
});
generator
.populate(require('/path/to/docset.json'));
docset.json
can be generated from jsdoc-dash-template