From 1d4f36a7d9f0cfd3f81d129fff306be22e55c8e8 Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Fri, 26 Aug 2016 11:48:27 -0700 Subject: [PATCH] [API] Include JSDoc for mct namespace only --- build/jsdoc/plugins/mct-only.js | 15 +++++++++++++++ jsdoc.json | 7 ++++--- 2 files changed, 19 insertions(+), 3 deletions(-) create mode 100644 build/jsdoc/plugins/mct-only.js diff --git a/build/jsdoc/plugins/mct-only.js b/build/jsdoc/plugins/mct-only.js new file mode 100644 index 0000000000..374c78335a --- /dev/null +++ b/build/jsdoc/plugins/mct-only.js @@ -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; + } + } + } +}; diff --git a/jsdoc.json b/jsdoc.json index f913b650d1..143c8da8e6 100644 --- a/jsdoc.json +++ b/jsdoc.json @@ -1,12 +1,13 @@ { "source": { "include": [ - "platform/" + "src/" ], - "includePattern": "platform/.+\\.js$", + "includePattern": "src/.+\\.js$", "excludePattern": ".+\\Spec\\.js$|lib/.+" }, "plugins": [ - "plugins/markdown" + "plugins/markdown", + "build/jsdoc/plugins/mct-only" ] }