cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

build(aio): compute and display short descriptions in methods (#22583)

Browse Source 
Previously only export docs were displaying a short description.
Now methods in classes and interfaces also compute and render
the short description.

Closes #22500

PR Close #22583
This commit is contained in:
Pete Bacon Darwin
2018-03-04 20:57:42 +00:00
committed by Alex Eagle
parent d0db9ded90
commit b3d1761825
2 changed files with 36 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
aio/tools/transforms/angular-api-package/index.js vendored
View File

@ -94,7 +94,7 @@ module.exports = new Package('angular-api', [basePackage, typeScriptPackage])
.config(function(splitDescription, EXPORT_DOC_TYPES) {
// Only split the description on the API docs
splitDescription.docTypes = EXPORT_DOC_TYPES;
splitDescription.docTypes = EXPORT_DOC_TYPES.concat(['member', 'function-overload']);
})
.config(function(computePathsProcessor, EXPORT_DOC_TYPES, generateApiListDoc) {
@ -130,6 +130,6 @@ module.exports = new Package('angular-api', [basePackage, typeScriptPackage])
]);
convertToJsonProcessor.docTypes = convertToJsonProcessor.docTypes.concat(DOCS_TO_CONVERT);
postProcessHtml.docTypes = convertToJsonProcessor.docTypes.concat(DOCS_TO_CONVERT);
autoLinkCode.docTypes = DOCS_TO_CONVERT.concat(['member']);
autoLinkCode.docTypes = DOCS_TO_CONVERT.concat(['member', 'function-overload']);
autoLinkCode.codeElements = ['code', 'code-example', 'code-pane'];
});