From 87916aec20a38cdfaa979589a00115e4b186896f Mon Sep 17 00:00:00 2001 From: Ibby Date: Thu, 23 Mar 2017 15:59:33 -0400 Subject: [PATCH] chore(docs): parse optional --- scripts/docs/dgeni-config.js | 11 ++++++----- scripts/docs/processors/parse-optional.js | 21 +++++++++++++++++++++ scripts/docs/templates/common.template.html | 3 +-- 3 files changed, 28 insertions(+), 7 deletions(-) create mode 100644 scripts/docs/processors/parse-optional.js diff --git a/scripts/docs/dgeni-config.js b/scripts/docs/dgeni-config.js index a317be29e..e0f632347 100644 --- a/scripts/docs/dgeni-config.js +++ b/scripts/docs/dgeni-config.js @@ -16,11 +16,12 @@ module.exports = function(currentVersion) { return new Package('ionic-v2-docs', [jsdocPackage, nunjucksPackage, typescriptPackage, linksPackage]) // .processor(require('./processors/latest-version')) -.processor(require('./processors/jekyll')) -.processor(require('./processors/remove-private-members')) -.processor(require('./processors/hide-private-api')) -.processor(require('./processors/collect-inputs-outputs')) -.processor(require('./processors/npm-id')) + .processor(require('./processors/jekyll')) + .processor(require('./processors/remove-private-members')) + .processor(require('./processors/hide-private-api')) + .processor(require('./processors/collect-inputs-outputs')) + .processor(require('./processors/npm-id')) + .processor(require('./processors/parse-optional')) // for debugging docs // .processor(function test(){ diff --git a/scripts/docs/processors/parse-optional.js b/scripts/docs/processors/parse-optional.js new file mode 100644 index 000000000..1cb50ebdc --- /dev/null +++ b/scripts/docs/processors/parse-optional.js @@ -0,0 +1,21 @@ +module.exports = function parseOptional() { + return { + $runBefore: ['rendering-docs'], + $process: function(docs) { + docs.forEach(function(doc) { + if(doc.members && doc.members.length) { + for (var i in doc.members) { + if(doc.members[i].params && doc.members[i].params.length) { + for (var ii in doc.members[i].params) { + if(doc.members[i].params[ii].optional){ + doc.members[i].params[ii].description += 'Optional'; + } + } + } + } + } + }); + return docs; + } + } +}; diff --git a/scripts/docs/templates/common.template.html b/scripts/docs/templates/common.template.html index f3c743369..e6b977b18 100644 --- a/scripts/docs/templates/common.template.html +++ b/scripts/docs/templates/common.template.html @@ -33,7 +33,7 @@ docType: "<$ doc.docType $>" <$ param.description | marked $> - <@ if param.optional @>Optional<@ endif @> + <@ if param.optional @>(optional)<@ endif @> <@ endfor @> @@ -77,7 +77,6 @@ docType: "<$ doc.docType $>" <$ param.description | marked $> - <@ if param.optional @>Optional<@ endif @> <@ if param.defaultValue @>

(default: <$ param.defaultValue $>)

<@ endif @>