angular/aio/tools/transforms/templates/api/class.template.html

{% import "lib/ngmodule.html" as ngModuleHelpers -%}
{% extends 'export-base.template.html' -%}
{% block overview -%}
  {% include "includes/class-overview.html" %}
{%- endblock %}
{% block details -%}
  {$ ngModuleHelpers.ngModuleList(doc.ngModules, 'Provided in') $}
  {% include "includes/description.html" %}
  {% include "includes/class-members.html" %}
{%- endblock %}
build(docs-infra): associate `providedIn` injectables with their NgModule (#41960) Such injectables were not appearing in the providers lists of their NgModule. This commit updates the doc-gen to support associating these automatically. Further, it also allows developers to mark other injectables that are provided in an NgModule with a reference to the NgModule where they are provided. The commit also does a refactoring of the `processNgModuleDocs` dgeni processor code, to make it easier to maintain. Fixes #41203 PR Close #41960 2021-05-06 11:25:24 +00:00			`{% import "lib/ngmodule.html" as ngModuleHelpers -%}`
build(aio): class API template once again extends export-base (#22534) PR Close #22534 2018-03-01 20:19:23 +00:00			`{% extends 'export-base.template.html' -%}`
perf(docs-infra): reduce unnecessary whitespace in API docs (#43435) The HTML for the docs pages is generated by Dgeni based on some [Nunjucks][1] templates. Previously, these templates were set up in a way that introduced a lot excess whitespace in the generated HTML, unnecessarily bloating the corresponding JSON files that need to be downloaded in order to view a certain docs page. This has been discussed in #28105 and was again observed while investigating #43285. This commit refactors some of the templates related to API docs (which seem to be the most affected ones) to drastically reduce the amount of excess whitespace. More specifically, the total size of all files in `generated/docs/api/` was reduced from ~13MB to ~7MB. Besides the reduced payload size for each API page, this change will also reduce the amount of memory needed by the ServiceWorker to cache the API pages that have been visited by a user. NOTE: The affected files are not eagerly downloaded when navigating to angular.io. Instead, each file is downloaded individually, as soon as a user visits the corresponding API docs page. Therefore, the impact of this change will be relatively small for most users. [1]: https://mozilla.github.io/nunjucks/ PR Close #43435 2021-09-14 10:59:19 +00:00			`{% block overview -%}`
feat(aio): first pass API docs redesign (#21874) Includes: * display ToC for API docs * update dgeni-packages to 0.24.1 * add floating sidebar in API docs * add breadcrumbs and structured data for Google crawler * improved rendering of method overloads * properties rendered in a table * params rendered with docs * removal of outdated "infobox" from all API docs PR Close #21874 2018-02-08 15:00:53 +00:00			`{% include "includes/class-overview.html" %}`
perf(docs-infra): reduce unnecessary whitespace in API docs (#43435) The HTML for the docs pages is generated by Dgeni based on some [Nunjucks][1] templates. Previously, these templates were set up in a way that introduced a lot excess whitespace in the generated HTML, unnecessarily bloating the corresponding JSON files that need to be downloaded in order to view a certain docs page. This has been discussed in #28105 and was again observed while investigating #43285. This commit refactors some of the templates related to API docs (which seem to be the most affected ones) to drastically reduce the amount of excess whitespace. More specifically, the total size of all files in `generated/docs/api/` was reduced from ~13MB to ~7MB. Besides the reduced payload size for each API page, this change will also reduce the amount of memory needed by the ServiceWorker to cache the API pages that have been visited by a user. NOTE: The affected files are not eagerly downloaded when navigating to angular.io. Instead, each file is downloaded individually, as soon as a user visits the corresponding API docs page. Therefore, the impact of this change will be relatively small for most users. [1]: https://mozilla.github.io/nunjucks/ PR Close #43435 2021-09-14 10:59:19 +00:00			`{%- endblock %}`
			`{% block details -%}`
build(docs-infra): associate `providedIn` injectables with their NgModule (#41960) Such injectables were not appearing in the providers lists of their NgModule. This commit updates the doc-gen to support associating these automatically. Further, it also allows developers to mark other injectables that are provided in an NgModule with a reference to the NgModule where they are provided. The commit also does a refactoring of the `processNgModuleDocs` dgeni processor code, to make it easier to maintain. Fixes #41203 PR Close #41960 2021-05-06 11:25:24 +00:00			`{$ ngModuleHelpers.ngModuleList(doc.ngModules, 'Provided in') $}`
build(aio): class API template once again extends export-base (#22534) PR Close #22534 2018-03-01 20:19:23 +00:00			`{% include "includes/description.html" %}`
build(docs-infra): improve directive API doc templates (#25768) Closes #22790 Closes #25530 PR Close #25768 2018-08-31 14:57:53 +00:00			`{% include "includes/class-members.html" %}`
perf(docs-infra): reduce unnecessary whitespace in API docs (#43435) The HTML for the docs pages is generated by Dgeni based on some [Nunjucks][1] templates. Previously, these templates were set up in a way that introduced a lot excess whitespace in the generated HTML, unnecessarily bloating the corresponding JSON files that need to be downloaded in order to view a certain docs page. This has been discussed in #28105 and was again observed while investigating #43285. This commit refactors some of the templates related to API docs (which seem to be the most affected ones) to drastically reduce the amount of excess whitespace. More specifically, the total size of all files in `generated/docs/api/` was reduced from ~13MB to ~7MB. Besides the reduced payload size for each API page, this change will also reduce the amount of memory needed by the ServiceWorker to cache the API pages that have been visited by a user. NOTE: The affected files are not eagerly downloaded when navigating to angular.io. Instead, each file is downloaded individually, as soon as a user visits the corresponding API docs page. Therefore, the impact of this change will be relatively small for most users. [1]: https://mozilla.github.io/nunjucks/ PR Close #43435 2021-09-14 10:59:19 +00:00			`{%- endblock %}`