diff --git a/lib/util/jsdoc.js b/lib/util/jsdoc.js index ddacbb17..a071150a 100644 --- a/lib/util/jsdoc.js +++ b/lib/util/jsdoc.js @@ -42,17 +42,18 @@ class MethodDef { } addParam({ - name, - label, - type, - optional, - description, - dictionary, - dependsOn, - uiComponent, - defaultValue, - schemaLoader, - }) { + name, + label, + type, + optional, + description, + dictionary, + dependsOn, + uiComponent, + defaultValue, + schemaLoader, + hidden, + }) { this.params.push(new ParamDef(name, label, type, optional, description, defaultValue)) if (dictionary) { @@ -86,6 +87,12 @@ class MethodDef { this.metaInfo.args[name].defaultValue = defaultValue } + + if (hidden) { + this.ensureMetaInfoArgument(name) + + this.metaInfo.args[name].hidden = true + } } addTag(name, value) { @@ -219,6 +226,7 @@ const tagHandlers = { dependsOn : paramDef.dependsOn, uiComponent : paramDef.uiComponent, defaultValue: paramDef.defaultValue, + hidden : paramDef.hidden, }) registeredParams[paramDef.name] = 1 @@ -298,17 +306,18 @@ exports.describeClasses = function(fileName) { item.params.forEach(param => { if (!registeredParams[param.name]) { const { - name, - label, - type, - optional, - description, - dictionary, - dependsOn, - schemaLoader, - uiComponent, - defaultValue, - } = param + name, + label, + type, + optional, + description, + dictionary, + dependsOn, + schemaLoader, + uiComponent, + defaultValue, + hidden, + } = param methodDef.addParam({ name, @@ -321,6 +330,7 @@ exports.describeClasses = function(fileName) { schemaLoader, uiComponent, defaultValue, + hidden, }) } })