ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-17 06:38:17 +00:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

[API] Include JSDoc for mct namespace only

Browse Source
This commit is contained in:
Victor Woeltjen
2016-08-26 11:48:27 -07:00
parent 0f96fbdd62
commit 1d4f36a7d9
2 changed files with 19 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
build/jsdoc/plugins/mct-only.js Normal file
View File

@ -0,0 +1,15 @@
module.exports = {
handlers: {
newDoclet: function (e) {
var doclet = e.doclet;
var memberof = doclet.memberof || "";
var longname = doclet.longname || "";
if (longname !== 'mct' && memberof.indexOf('mct') !== 0) {
e.preventDefault = true;
e.stopPropagation = true;
doclet.ignore = true;
}
}
}
};

7
jsdoc.json
View File

@ -1,12 +1,13 @@
{ {
"source": { "source": {
"include": [ "include": [
"platform/" "src/"
], ],
"includePattern": "platform/.+\\.js$", "includePattern": "src/.+\\.js$",
"excludePattern": ".+\\Spec\\.js$|lib/.+" "excludePattern": ".+\\Spec\\.js$|lib/.+"
}, },
"plugins": [ "plugins": [
"plugins/markdown" "plugins/markdown",
"build/jsdoc/plugins/mct-only"
] ]
} }