diff --git a/tools/doc/common.js b/tools/doc/common.js index 4dfadd353d9ec8..7d8aefb65d84fd 100644 --- a/tools/doc/common.js +++ b/tools/doc/common.js @@ -34,6 +34,10 @@ function extractAndParseYAML(text) { meta.deprecated = arrify(meta.deprecated); } + if (meta.removed) { + meta.removed = arrify(meta.removed); + } + meta.changes = meta.changes || []; return meta; diff --git a/tools/doc/html.js b/tools/doc/html.js index d65a4b323aef36..f1ac9e144e61e1 100644 --- a/tools/doc/html.js +++ b/tools/doc/html.js @@ -264,6 +264,7 @@ function parseYAML(text) { const added = { description: '' }; const deprecated = { description: '' }; + const removed = { description: '' }; if (meta.added) { added.version = meta.added.join(', '); @@ -276,9 +277,15 @@ function parseYAML(text) { `Deprecated since: ${deprecated.version}`; } + if (meta.removed) { + removed.version = meta.removed.join(', '); + removed.description = `Removed in: ${removed.version}`; + } + if (meta.changes.length > 0) { if (added.description) meta.changes.push(added); if (deprecated.description) meta.changes.push(deprecated); + if (removed.description) meta.changes.push(removed); meta.changes.sort((a, b) => versionSort(a.version, b.version)); @@ -299,7 +306,8 @@ function parseYAML(text) { result += '\n\n'; } else { - result += `${added.description}${deprecated.description}\n`; + result += `${added.description}${deprecated.description}` + + `${removed.description}\n`; } if (meta.napiVersion) {