diff --git a/tools/api-builder/angular.io-package/processors/addJadeDataDocsProcessor.js b/tools/api-builder/angular.io-package/processors/addJadeDataDocsProcessor.js index f33e2e223f..af64851333 100644 --- a/tools/api-builder/angular.io-package/processors/addJadeDataDocsProcessor.js +++ b/tools/api-builder/angular.io-package/processors/addJadeDataDocsProcessor.js @@ -76,12 +76,34 @@ module.exports = function addJadeDataDocsProcessor() { stability = 'deprecated'; } + var howToUse = ''; + if(_.has(exportDoc, 'howToUse')) { + var howToUseArray = exportDoc.tags.tags.filter(function(tag) { + return tag.tagName === 'howToUse' + }); + + // Remove line breaks, there should only be one tag + howToUse = howToUseArray[0].description.replace(/(\r\n|\n|\r)/gm,""); + } + + var whatItDoes = ''; + if(_.has(exportDoc, 'whatItDoes')) { + var whatItDoesArray = exportDoc.tags.tags.filter(function(tag) { + return tag.tagName === 'whatItDoes' + }); + + // Remove line breaks, there should only be one tag + whatItDoes = whatItDoesArray[0].description.replace(/(\r\n|\n|\r)/gm,""); + } + var dataDoc = { name: exportDoc.name + '-' + exportDoc.docType, title: exportDoc.name, docType: exportDoc.docType, exportDoc: exportDoc, - stability: stability + stability: stability, + howToUse: howToUse, + whatItDoes: whatItDoes }; if (exportDoc.symbolTypeName) dataDoc.varType = titleCase(exportDoc.symbolTypeName); diff --git a/tools/api-builder/angular.io-package/templates/api-list-data.template.html b/tools/api-builder/angular.io-package/templates/api-list-data.template.html index b5fbe2cacb..7b009ec0b7 100644 --- a/tools/api-builder/angular.io-package/templates/api-list-data.template.html +++ b/tools/api-builder/angular.io-package/templates/api-list-data.template.html @@ -4,7 +4,12 @@ { "title": "{$ item.title $}", "path": "{$ item.exportDoc.path $}", - "docType": "{$ item.docType $}" + "docType": "{$ item.docType $}", + "stability": "{$ item.stability $}", + "secure": "{$ item.security $}", + "howToUse": "{$ item.howToUse $}", + "whatItDoes": {% if item.whatItDoes %}"Exists"{% else %}"Not Done"{% endif %}, + "barrel" : "{$ module $}" }{% if not loop.last %},{% endif %} {% endfor %}]{% if not loop.last %},{% endif %} {% endfor -%}