Secure your code as it's written. Use Snyk Code to scan source code in minutes - no build needed - and fix issues immediately.
* add-links: Add links to the source code for protractor.js, locators.js,
* and webdriver.js.
* add-toc: Add the table of contents.
*/
config.append('processing.processors', [
require('./processors/tag-fixer'),
require('./processors/filter-jsdoc'),
require('./processors/add-links'),
require('./processors/add-toc')
]);
// Configure the tags that will be parsed from the jsDoc.
var tagDefs = require('dgeni-packages/jsdoc/tag-defs');
// Parse the following annotations.
tagDefs.push({name: 'alias'});
tagDefs.push({name: 'augments'});
tagDefs.push({name: 'deprecated'});
tagDefs.push({name: 'example'});
tagDefs.push({name: 'private'});
tagDefs.push({name: 'see'});
tagDefs.push({name: 'type'});
tagDefs.push({name: 'view'});
// The name tag should not be required.
var nameTag = _.find(tagDefs, {name: 'name'});
nameTag.required = false;
config.set('processing.tagDefinitions', tagDefs);
// OutputPath for docs that do not already have them.
config.set('rendering.contentsFolder',
*/
config.append('rendering.filters', [
require('./filters/link-slugify')
]);
// Configure the tags that will be parsed from the jsDoc.
var tagDefs = require('dgeni-packages/jsdoc/tag-defs');
// Parse the following annotations.
tagDefs.push({name: 'alias'});
tagDefs.push({name: 'augments'});
tagDefs.push({name: 'deprecated'});
tagDefs.push({name: 'example'});
tagDefs.push({name: 'private'});
tagDefs.push({name: 'see'});
tagDefs.push({name: 'type'});
tagDefs.push({name: 'view'});
// The name tag should not be required.
var nameTag = _.find(tagDefs, {name: 'name'});
nameTag.required = false;
config.set('processing.tagDefinitions', tagDefs);
// OutputPath for docs that do not already have them.
config.set('rendering.contentsFolder',
path.resolve(config.basePath, 'build'));
// Base path is the protractor root dir.
var basePath = path.resolve(packagePath, '..');
// Generate documentation for protractor, locators, and webdriver.