iSharkFly-Docs
/
angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

build(aio): ensure usageNotes are copied into decorator API docs (#23901) 

PR Close #23901
This commit is contained in:
Pete Bacon Darwin 2018-05-14 17:25:41 +01:00 committed by Alex Rickabaugh
parent d4b8b24406
commit a2e8b3a6a8
2 changed files with 3 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
aio/tools/transforms/angular-api-package/processors/mergeDecoratorDocs.js vendored
View File

@ -90,8 +90,7 @@ module.exports = function mergeDecoratorDocs(log) {
callMember.description.substring(0, 50)); callMember.description.substring(0, 50));
// Merge the documentation found in this call signature into the original decorator // Merge the documentation found in this call signature into the original decorator
decoratorDoc.description = callMember.description; decoratorDoc.description = callMember.description;
decoratorDoc.howToUse = callMember.howToUse; decoratorDoc.usageNotes = callMember.usageNotes;
decoratorDoc.whatItDoes = callMember.whatItDoes;
// remove doc from its module doc's exports // remove doc from its module doc's exports
doc.moduleDoc.exports = doc.moduleDoc.exports =

6
aio/tools/transforms/angular-api-package/processors/mergeDecoratorDocs.spec.js
View File

@ -32,8 +32,7 @@ describe('mergeDecoratorDocs processor', () => {
{ {
isCallMember: true, isCallMember: true,
description: 'The actual description of the call signature', description: 'The actual description of the call signature',
whatItDoes: 'Does something cool...', usageNotes: 'Use it like this...'
howToUse: 'Use it like this...'
}, },
{ {
description: 'Some other member' description: 'Some other member'
@ -69,8 +68,7 @@ describe('mergeDecoratorDocs processor', () => {
it('should copy across properties from the call signature doc', () => { it('should copy across properties from the call signature doc', () => {
processor.$process([decoratorDoc, metadataDoc, otherDoc]); processor.$process([decoratorDoc, metadataDoc, otherDoc]);
expect(decoratorDoc.description).toEqual('The actual description of the call signature'); expect(decoratorDoc.description).toEqual('The actual description of the call signature');
expect(decoratorDoc.whatItDoes).toEqual('Does something cool...'); expect(decoratorDoc.usageNotes).toEqual('Use it like this...');
expect(decoratorDoc.howToUse).toEqual('Use it like this...');
}); });
it('should remove the metadataDoc from the module exports', () => { it('should remove the metadataDoc from the module exports', () => {