Differentiating doc from apidoc
This renames the doc task to apidoc. The apidoc delegates to jsdoc3 currently. We will have additional documentation that is not built by jsdoc3. It makes sense to reserve the more general 'doc' name for building all documentation (not just apidoc).
This commit is contained in:
16
apidoc/plugins/inheritdoc.js
Normal file
16
apidoc/plugins/inheritdoc.js
Normal file
@@ -0,0 +1,16 @@
|
||||
/*
|
||||
* This is a hack to prevent inheritDoc and override tags from entirely removing
|
||||
* documentation of the method that inherits the documentation.
|
||||
*
|
||||
* TODO: Remove this hack when https://github.com/jsdoc3/jsdoc/issues/53
|
||||
* is addressed.
|
||||
*/
|
||||
exports.nodeVisitor = {
|
||||
|
||||
visitNode: function(node, e, parser, currentSourceName) {
|
||||
if (/@(inheritDoc|override)(\n|\r)/.test(e.comment)) {
|
||||
e.preventDefault = true;
|
||||
}
|
||||
}
|
||||
|
||||
};
|
||||
Reference in New Issue
Block a user