build(aio): render doc-gen issues in overview dump (#22675)

Related to #22138

PR Close #22675
This commit is contained in:
Pete Bacon Darwin
2018-03-09 08:34:58 +00:00
committed by Kara Erickson
parent 37fedd001c
commit 6f0dad1710
7 changed files with 86 additions and 47 deletions

View File

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

View File

@ -1,6 +1,7 @@
module.exports = function(log, createDocMessage) {
return {
name: 'stable',
deprecated: true,
transforms(doc, tag, value) {
log.warn(createDocMessage('Deprecated `@stable` tag found', doc));
log.warn('PLEASE REMOVE - its value is now computed.');

View File

@ -1,6 +1,7 @@
module.exports = function(log, createDocMessage) {
return {
name: 'whatItDoes',
deprecated: true,
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.');