diff --git a/aio/tools/transforms/angular-api-package/tag-defs/howToUse.js b/aio/tools/transforms/angular-api-package/tag-defs/howToUse.js index aa5f3a2974c07..a0d7968e07845 100644 --- a/aio/tools/transforms/angular-api-package/tag-defs/howToUse.js +++ b/aio/tools/transforms/angular-api-package/tag-defs/howToUse.js @@ -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.'); diff --git a/aio/tools/transforms/angular-api-package/tag-defs/stable.js b/aio/tools/transforms/angular-api-package/tag-defs/stable.js index 7146ebdcb4efe..cc689085c0021 100644 --- a/aio/tools/transforms/angular-api-package/tag-defs/stable.js +++ b/aio/tools/transforms/angular-api-package/tag-defs/stable.js @@ -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.'); diff --git a/aio/tools/transforms/angular-api-package/tag-defs/whatItDoes.js b/aio/tools/transforms/angular-api-package/tag-defs/whatItDoes.js index 86715c6a5b913..8b995890a972b 100644 --- a/aio/tools/transforms/angular-api-package/tag-defs/whatItDoes.js +++ b/aio/tools/transforms/angular-api-package/tag-defs/whatItDoes.js @@ -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.'); diff --git a/aio/tools/transforms/angular-base-package/index.js b/aio/tools/transforms/angular-base-package/index.js index f76b80762a53c..75e496ec3b166 100644 --- a/aio/tools/transforms/angular-base-package/index.js +++ b/aio/tools/transforms/angular-base-package/index.js @@ -24,7 +24,6 @@ module.exports = new Package('angular-base', [ // Register the processors .processor(require('./processors/generateKeywords')) - .processor(require('./processors/createOverviewDump')) .processor(require('./processors/createSitemap')) .processor(require('./processors/checkUnbalancedBackTicks')) .processor(require('./processors/convertToJson')) diff --git a/aio/tools/transforms/angular.io-package/index.js b/aio/tools/transforms/angular.io-package/index.js index 3184be07d051f..cb24f95e991d1 100644 --- a/aio/tools/transforms/angular.io-package/index.js +++ b/aio/tools/transforms/angular.io-package/index.js @@ -17,6 +17,7 @@ module.exports = new Package('angular.io', [gitPackage, apiPackage, contentPacka // This processor relies upon the versionInfo. See below... .processor(require('./processors/processNavigationMap')) + .processor(require('./processors/createOverviewDump')) .processor(require('./processors/cleanGeneratedFiles')) // We don't include this in the angular-base package because the `versionInfo` stuff diff --git a/aio/tools/transforms/angular-base-package/processors/createOverviewDump.js b/aio/tools/transforms/angular.io-package/processors/createOverviewDump.js similarity index 100% rename from aio/tools/transforms/angular-base-package/processors/createOverviewDump.js rename to aio/tools/transforms/angular.io-package/processors/createOverviewDump.js diff --git a/aio/tools/transforms/templates/overview-dump.template.html b/aio/tools/transforms/templates/overview-dump.template.html index 63d552eb56ad3..14039af667290 100644 --- a/aio/tools/transforms/templates/overview-dump.template.html +++ b/aio/tools/transforms/templates/overview-dump.template.html @@ -1,74 +1,110 @@ {% import "api/lib/githubLinks.html" as github -%} -{% import "api/lib/paramList.html" as params -%} +{% import "api/lib/memberHelpers.html" as members -%} +{% macro goToCode(doc) %}{% endmacro %} +{% macro label(test, class, text) %}{% if test %}{% endif %}{% endmacro %} +{% macro renderLabels(doc) -%} + {$ label(doc.notYetDocumented, 'no-doc', 'UNDOCUMENTED') $} + {%- for tag in doc.tags.tags %}{$ label(tag.tagDef.deprecated, 'deprecated', '@' + tag.tagDef.name + ' deprecated') $}{% endfor %} +{% endmacro %} +{% macro renderMember(member) -%} +
{$ goToCode(member) $} +

{$ members.renderMemberSyntax(member, 1) $}

+ {$ renderLabels(member) $} +
+{% endmacro -%} + + -

Module Overview

+

Documentation Status Report

{% for module in doc.modules %} - -

- {$ module.id $}{%- if module.public %} (public){% endif %} -

+
+

{$ module.id $}{%- if module.public %} (public){% endif %}

{% for export in module.exports %} -

- - {$ export.docType $} {$ export.name $} - -

- {%- if export.constructorDoc %} -

- - {$ export.constructorDoc.name $}{$ params.paramList(export.constructorDoc.params) $} - -

- {% endif -%} - {%- for member in export.members %} -

- - {$ member.name $}{$ params.paramList(member.params) $} - -

- {% endfor %} +
{$ goToCode(export) $} +
+

{$ export.docType $} {$ export.name $}

{$ renderLabels(export) $}
- {% endfor %} + {%- for member in export.staticProperties %}{% if not member.internal %} + {$ renderMember(member) $}{% endif %}{% endfor -%} + {% for member in export.staticMethods %}{% if not member.internal %} + {$ renderMember(member) $}{% endif %}{% endfor -%} + {% if export.constructorDoc and not export.constructorexport.internal %} + {$ renderMember(export.constructorDoc) $}{% endif -%} + {% for member in export.properties %}{% if not member.internal %} + {$ renderMember(member) $}{% endif %}{% endfor -%} + {% for member in export.methods %}{% if not member.internal %} + {$ renderMember(member) $}{% endif %}{% endfor -%} +
+
+ {% endfor %} +
{% endfor %} -