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

build(aio): deprecate `@howToUse` and `@whatItDoes` tags (#22401) 

See https://github.com/angular/angular/issues/22135#issuecomment-367632372

PR Close #22401
This commit is contained in:
Pete Bacon Darwin 2018-02-23 13:45:38 +00:00 committed by Alex Eagle
parent 8c358844dd
commit e75f0cee18
2 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
aio/tools/transforms/angular-api-package/tag-defs/howToUse.js vendored
View File

@ -1,3 +1,10 @@
module.exports = function() {
return {name: 'howToUse'};
module.exports = function(log, createDocMessage) {
return {
name: 'howToUse',
transforms(doc, tag, value) {
log.warn(createDocMessage('Deprecated `@howToUse` tag found', doc));
log.warn('PLEASE FIX by renaming to `@usageNotes.');
return value;
}
};
};

11
aio/tools/transforms/angular-api-package/tag-defs/whatItDoes.js vendored
View File

@ -1,3 +1,10 @@
module.exports = function() {
return {name: 'whatItDoes'};
module.exports = function(log, createDocMessage) {
return {
name: 'whatItDoes',
transforms(doc, tag, value) {
log.warn(createDocMessage('Deprecated `@whatItDoes` tag found', doc));
log.warn('PLEASE FIX by adding the content of this tag as the first paragraph of the `@description` tag.');
return value;
}
};
};