Zhicheng WANG
8663fa04a8
Merge remote-tracking branch 'en/master' into aio
...
# Conflicts:
# .nvmrc
# aio/content/cli/index.md
# aio/content/guide/ajs-quick-reference.md
# aio/content/guide/animations.md
# aio/content/guide/aot-compiler.md
# aio/content/guide/app-shell.md
# aio/content/guide/architecture-components.md
# aio/content/guide/architecture-modules.md
# aio/content/guide/architecture-services.md
# aio/content/guide/architecture.md
# aio/content/guide/attribute-directives.md
# aio/content/guide/bazel.md
# aio/content/guide/bootstrapping.md
# aio/content/guide/browser-support.md
# aio/content/guide/build.md
# aio/content/guide/cheatsheet.md
# aio/content/guide/cli-builder.md
# aio/content/guide/comparing-observables.md
# aio/content/guide/complex-animation-sequences.md
# aio/content/guide/component-interaction.md
# aio/content/guide/component-styles.md
# aio/content/guide/creating-libraries.md
# aio/content/guide/dependency-injection-in-action.md
# aio/content/guide/dependency-injection-navtree.md
# aio/content/guide/dependency-injection-providers.md
# aio/content/guide/dependency-injection.md
# aio/content/guide/deployment.md
# aio/content/guide/deprecations.md
# aio/content/guide/displaying-data.md
# aio/content/guide/dynamic-component-loader.md
# aio/content/guide/dynamic-form.md
# aio/content/guide/elements.md
# aio/content/guide/entry-components.md
# aio/content/guide/feature-modules.md
# aio/content/guide/file-structure.md
# aio/content/guide/form-validation.md
# aio/content/guide/forms-overview.md
# aio/content/guide/forms.md
# aio/content/guide/frequent-ngmodules.md
# aio/content/guide/glossary.md
# aio/content/guide/hierarchical-dependency-injection.md
# aio/content/guide/http.md
# aio/content/guide/i18n.md
# aio/content/guide/ivy.md
# aio/content/guide/language-service.md
# aio/content/guide/lazy-loading-ngmodules.md
# aio/content/guide/lifecycle-hooks.md
# aio/content/guide/module-types.md
# aio/content/guide/ngmodule-api.md
# aio/content/guide/ngmodule-faq.md
# aio/content/guide/ngmodule-vs-jsmodule.md
# aio/content/guide/ngmodules.md
# aio/content/guide/npm-packages.md
# aio/content/guide/observables-in-angular.md
# aio/content/guide/observables.md
# aio/content/guide/pipes.md
# aio/content/guide/providers.md
# aio/content/guide/reactive-forms.md
# aio/content/guide/releases.md
# aio/content/guide/reusable-animations.md
# aio/content/guide/route-animations.md
# aio/content/guide/router.md
# aio/content/guide/rx-library.md
# aio/content/guide/schematics-authoring.md
# aio/content/guide/schematics-for-libraries.md
# aio/content/guide/schematics.md
# aio/content/guide/security.md
# aio/content/guide/service-worker-communications.md
# aio/content/guide/service-worker-config.md
# aio/content/guide/service-worker-devops.md
# aio/content/guide/service-worker-getting-started.md
# aio/content/guide/service-worker-intro.md
# aio/content/guide/set-document-title.md
# aio/content/guide/setup-local.md
# aio/content/guide/sharing-ngmodules.md
# aio/content/guide/singleton-services.md
# aio/content/guide/static-query-migration.md
# aio/content/guide/structural-directives.md
# aio/content/guide/styleguide.md
# aio/content/guide/template-syntax.md
# aio/content/guide/testing.md
# aio/content/guide/transition-and-triggers.md
# aio/content/guide/typescript-configuration.md
# aio/content/guide/universal.md
# aio/content/guide/updating.md
# aio/content/guide/upgrade-setup.md
# aio/content/guide/upgrade.md
# aio/content/guide/user-input.md
# aio/content/guide/using-libraries.md
# aio/content/guide/visual-studio-2015.md
# aio/content/guide/web-worker.md
# aio/content/guide/workspace-config.md
# aio/content/marketing/events.html
# aio/content/marketing/resources.json
# aio/content/navigation.json
# aio/content/start/data.md
# aio/content/start/deployment.md
# aio/content/start/forms.md
# aio/content/start/index.md
# aio/content/start/routing.md
# aio/content/tutorial/index.md
# aio/content/tutorial/toh-pt0.md
# aio/content/tutorial/toh-pt1.md
# aio/content/tutorial/toh-pt2.md
# aio/content/tutorial/toh-pt3.md
# aio/content/tutorial/toh-pt4.md
# aio/content/tutorial/toh-pt5.md
# aio/content/tutorial/toh-pt6.md
# aio/package.json
# aio/src/app/app.component.spec.ts
# aio/src/app/custom-elements/api/api-list.component.html
# aio/src/app/layout/doc-viewer/doc-viewer.component.ts
# aio/src/app/layout/mode-banner/mode-banner.component.ts
# aio/src/app/layout/nav-item/nav-item.component.html
# aio/src/app/shared/toc.service.ts
# aio/src/styles/0-base/_typography.scss
# aio/src/styles/2-modules/_api-pages.scss
# aio/tools/transforms/templates/api/lib/memberHelpers.html
# aio/yarn.lock
# packages/common/http/src/headers.ts
# packages/common/http/src/interceptor.ts
# packages/common/http/src/params.ts
# packages/common/http/src/response.ts
# packages/common/src/common_module.ts
# packages/common/src/directives/ng_for_of.ts
# packages/common/src/location/location.ts
# packages/common/src/pipes/date_pipe.ts
# packages/core/src/change_detection/pipe_transform.ts
# packages/core/src/di/injectable.ts
# packages/core/src/metadata/di.ts
# packages/core/src/metadata/directives.ts
# packages/core/src/metadata/ng_module.ts
# packages/core/src/render3/component_ref.ts
# packages/forms/src/directives/reactive_directives/form_control_name.ts
# packages/forms/src/form_builder.ts
# packages/forms/src/model.ts
# packages/forms/src/validators.ts
# packages/router/src/config.ts
# packages/router/src/directives/router_outlet.ts
# packages/router/src/events.ts
# packages/router/src/router.ts
# packages/router/src/router_module.ts
# packages/router/src/router_state.ts
# packages/router/src/shared.ts
2020-01-24 15:55:22 +08:00
Kristiyan Kostadinov
e7cf1e0580
feat(docs-infra): add the ability to expose globals ( #34237 )
...
Adds the ability to expose global symbols in the API docs via the `@globalApi` tag. Also supports optionally setting a namespace which will be added to the name automatically (e.g. `foo` will be renamed to `ng.foo`). Relevant APIs should also be exported through the `global.ts` file which will show up under `core/global`.
PR Close #34237
2019-12-06 10:58:09 -08:00
George Kalpakas
9364a14d36
fix(docs-infra): ignore ng*Def members in API docs ( #31378 )
...
`ng*Def` properties (such as `ngInjectorDef`) are not considered part of
the public API and should not appear in the API docs. This commit adds a
filter to remove these properties from the docs metadata.
PR Close #31378
2019-10-03 10:24:34 -07:00
Zhicheng WANG
d5057aec3b
Merge remote-tracking branch 'en/master' into aio
2019-06-03 10:09:20 +08:00
Pete Bacon Darwin
a4f3f3f81d
build(docs-infra): support doc aliases via @alias dgeni tag ( #29673 )
...
Now, one can add an `@alias` tag to API docs, which tells dgeni that this
API element (usually a `const`) is really just an alias for some API element
defined elsewhere.
Dgeni will then look up this API element and copy over the properties from
the alias to the current doc.
For example, we would like to privately export an Enum from `@angular/core`
but then publicly export this from `@angular/common`:
**packages/core/private_exports.ts**
```ts
/**
* Description of this document.
*/
export enum ɵSomeEnum { ... }
```
**packages/common/public_api.ts**
```ts
import {ɵSomeEnum} from '@angular/core';
/**
* @alias core/ɵSomeEnum
*/
export const SomeEnum = ɵSomeEnum;
```
In the generated docs there will be a page for `common/SomeEnum`, which
will be rendered as an enum, rather than a const, showing the description
extracted from the `core/ɵSomeEnum`.
---
The implementation of this feature required some refactoring of the other
processing:
1. Previously `ɵ` prefixed exports were not even considered.
2. Due to 1. some processors needed to have guards added to ignore such
private exports (`addMetadataAliases` and `checkContentRules`).
3. The processing of package pages had to be reworked (and split) so that
it picked up the aliased export docs after their alias proeprties had
been copied.
See FW-1207, FW-632, #29249
PR Close #29673
2019-04-04 10:52:36 -07:00
Adam Plumer
6b6fdffc12
fixup! docs: update Universal guide ( #28296 )
...
PR Close #28296
2019-03-11 10:52:18 -07:00
Adam Plumer
a29ce57732
docs: migrate examples from @angular/http to @angular/common/http ( #28296 )
...
PR Close #28296
2019-03-11 10:52:17 -07:00
Zhicheng WANG
8744f17f5d
Merge remote-tracking branch 'en/master' into aio
...
# Conflicts:
# aio/content/cli/index.md
# aio/content/file-not-found.md
# aio/content/guide/architecture-modules.md
# aio/content/guide/architecture-services.md
# aio/content/guide/build.md
# aio/content/guide/deployment.md
# aio/content/guide/elements.md
# aio/content/guide/feature-modules.md
# aio/content/guide/file-structure.md
# aio/content/guide/forms-overview.md
# aio/content/guide/glossary.md
# aio/content/guide/i18n.md
# aio/content/guide/npm-packages.md
# aio/content/guide/releases.md
# aio/content/guide/router.md
# aio/content/guide/service-worker-config.md
# aio/content/guide/service-worker-intro.md
# aio/content/guide/testing.md
# aio/content/guide/upgrade-performance.md
# aio/content/navigation.json
# aio/content/tutorial/toh-pt0.md
# aio/content/tutorial/toh-pt5.md
# aio/content/tutorial/toh-pt6.md
# aio/package.json
# aio/src/app/custom-elements/api/api-list.component.ts
# aio/src/app/documents/document.service.ts
# aio/src/app/layout/top-menu/top-menu.component.ts
# aio/src/index.html
# aio/src/styles/2-modules/_api-pages.scss
# aio/tools/transforms/templates/api/base.template.html
# aio/tools/transforms/templates/api/lib/memberHelpers.html
# aio/tools/transforms/templates/cli/cli-container.template.html
# aio/tools/transforms/templates/lib/githubLinks.html
# aio/yarn.lock
# packages/animations/src/animation_metadata.ts
# packages/common/http/src/backend.ts
# packages/common/http/src/client.ts
# packages/common/http/src/headers.ts
# packages/common/http/src/interceptor.ts
# packages/common/http/src/module.ts
# packages/common/http/src/params.ts
# packages/common/http/src/request.ts
# packages/common/http/src/response.ts
# packages/common/src/common_module.ts
# packages/common/src/directives/ng_class.ts
# packages/common/src/directives/ng_style.ts
# packages/common/src/directives/ng_switch.ts
# packages/common/src/i18n/format_date.ts
# packages/common/src/pipes/number_pipe.ts
# packages/core/src/change_detection/change_detection_util.ts
# packages/core/src/change_detection/pipe_transform.ts
# packages/core/src/di/injectable.ts
# packages/core/src/linker/element_ref.ts
# packages/core/src/linker/template_ref.ts
# packages/core/src/metadata/di.ts
# packages/core/src/metadata/directives.ts
# packages/core/src/metadata/lifecycle_hooks.ts
# packages/core/src/metadata/ng_module.ts
# packages/core/src/render/api.ts
# packages/forms/src/directives/form_interface.ts
# packages/forms/src/directives/ng_form.ts
# packages/forms/src/directives/ng_model.ts
# packages/forms/src/directives/reactive_directives/form_control_name.ts
# packages/forms/src/directives/select_control_value_accessor.ts
# packages/forms/src/directives/validators.ts
# packages/forms/src/form_builder.ts
# packages/forms/src/form_providers.ts
# packages/forms/src/model.ts
# packages/forms/src/validators.ts
# packages/platform-browser/src/browser.ts
# packages/platform-browser/src/security/dom_sanitization_service.ts
# packages/router/src/config.ts
# packages/router/src/events.ts
# packages/router/src/router.ts
# packages/router/src/router_module.ts
# packages/router/src/shared.ts
2018-12-29 16:04:37 +08:00
Zhicheng Wang
a9ac90d3df
Merge remote-tracking branch 'en/master' into aio
...
# Conflicts:
# aio/content/guide/ajs-quick-reference.md
# aio/content/guide/animations.md
# aio/content/guide/aot-compiler.md
# aio/content/guide/architecture-components.md
# aio/content/guide/architecture-modules.md
# aio/content/guide/architecture-next-steps.md
# aio/content/guide/architecture-services.md
# aio/content/guide/architecture.md
# aio/content/guide/attribute-directives.md
# aio/content/guide/bootstrapping.md
# aio/content/guide/browser-support.md
# aio/content/guide/cheatsheet.md
# aio/content/guide/comparing-observables.md
# aio/content/guide/component-interaction.md
# aio/content/guide/component-styles.md
# aio/content/guide/dependency-injection-in-action.md
# aio/content/guide/dependency-injection-pattern.md
# aio/content/guide/dependency-injection.md
# aio/content/guide/deployment.md
# aio/content/guide/displaying-data.md
# aio/content/guide/dynamic-component-loader.md
# aio/content/guide/elements.md
# aio/content/guide/feature-modules.md
# aio/content/guide/form-validation.md
# aio/content/guide/forms.md
# aio/content/guide/glossary.md
# aio/content/guide/hierarchical-dependency-injection.md
# aio/content/guide/i18n.md
# aio/content/guide/lazy-loading-ngmodules.md
# aio/content/guide/lifecycle-hooks.md
# aio/content/guide/ngmodule-faq.md
# aio/content/guide/ngmodule-vs-jsmodule.md
# aio/content/guide/ngmodules.md
# aio/content/guide/npm-packages.md
# aio/content/guide/observables-in-angular.md
# aio/content/guide/observables.md
# aio/content/guide/pipes.md
# aio/content/guide/practical-observable-usage.md
# aio/content/guide/providers.md
# aio/content/guide/quickstart.md
# aio/content/guide/reactive-forms.md
# aio/content/guide/router.md
# aio/content/guide/rx-library.md
# aio/content/guide/security.md
# aio/content/guide/service-worker-communications.md
# aio/content/guide/service-worker-getting-started.md
# aio/content/guide/service-worker-intro.md
# aio/content/guide/setup-systemjs-anatomy.md
# aio/content/guide/setup.md
# aio/content/guide/singleton-services.md
# aio/content/guide/structural-directives.md
# aio/content/guide/styleguide.md
# aio/content/guide/template-syntax.md
# aio/content/guide/testing.md
# aio/content/guide/typescript-configuration.md
# aio/content/guide/universal.md
# aio/content/guide/updating.md
# aio/content/guide/upgrade.md
# aio/content/guide/user-input.md
# aio/content/guide/visual-studio-2015.md
# aio/content/marketing/docs.md
# aio/content/navigation.json
# aio/content/tutorial/toh-pt0.md
# aio/content/tutorial/toh-pt1.md
# aio/content/tutorial/toh-pt2.md
# aio/content/tutorial/toh-pt3.md
# aio/content/tutorial/toh-pt4.md
# aio/content/tutorial/toh-pt5.md
# aio/content/tutorial/toh-pt6.md
# aio/ngsw-manifest.json
# aio/package.json
# aio/src/app/custom-elements/api/api-list.component.html
# aio/src/app/custom-elements/api/api-list.component.ts
# aio/src/index.html
# aio/tools/transforms/templates/api/base.template.html
# aio/tools/transforms/templates/api/class.template.html
# aio/tools/transforms/templates/api/directive.template.html
# aio/tools/transforms/templates/api/enum.template.html
# aio/tools/transforms/templates/api/includes/class-overview.html
# aio/tools/transforms/templates/api/includes/deprecation.html
# aio/tools/transforms/templates/api/includes/export-as.html
# aio/tools/transforms/templates/api/includes/info-bar.html
# aio/tools/transforms/templates/api/includes/interface-overview.html
# aio/tools/transforms/templates/api/includes/selectors.html
# aio/tools/transforms/templates/api/lib/directiveHelpers.html
# aio/tools/transforms/templates/api/lib/githubLinks.html
# aio/tools/transforms/templates/api/lib/memberHelpers.html
# aio/tools/transforms/templates/api/package.template.html
# aio/yarn.lock
# packages/common/http/src/module.ts
# packages/common/src/common_module.ts
# packages/common/src/directives/ng_for_of.ts
# packages/common/src/directives/ng_if.ts
# packages/common/src/directives/ng_template_outlet.ts
# packages/common/src/location/location.ts
# packages/common/src/pipes/async_pipe.ts
# packages/common/src/pipes/json_pipe.ts
# packages/common/src/pipes/number_pipe.ts
# packages/common/src/pipes/slice_pipe.ts
# packages/core/src/change_detection/change_detector_ref.ts
# packages/core/src/di/injectable.ts
# packages/core/src/linker/template_ref.ts
# packages/core/src/linker/view_container_ref.ts
# packages/core/src/metadata/di.ts
# packages/core/src/metadata/ng_module.ts
# packages/core/src/render/api.ts
# packages/forms/src/directives/form_interface.ts
# packages/forms/src/directives/ng_form.ts
# packages/forms/src/directives/ng_model.ts
# packages/forms/src/directives/reactive_directives/form_control_name.ts
# packages/forms/src/directives/select_control_value_accessor.ts
# packages/forms/src/directives/validators.ts
# packages/forms/src/form_providers.ts
# packages/forms/src/model.ts
# packages/forms/src/validators.ts
# packages/router/src/config.ts
# packages/router/src/router.ts
# packages/router/src/router_module.ts
# packages/router/src/router_state.ts
2018-10-21 17:43:29 +08:00
Pete Bacon Darwin
4c0ad5238e
build(docs-infra): display github links in CLI API docs ( #26515 )
...
This commit includes the following changes:
* CLI version information is read from the CLI package from which
we read the help files.
* CLI API pages now contain GH links
* line numbers are not shown in GH links, if the doc does not
have a truthy `startingLine` value. This allows us to remove
hard coded checks for `guide` pages
* content pages and CLI api docs no longer have a `startingLine`
* the hard-coded `packages` path segment has been removed from
the templates; instead we now only use the `realProjectRelativePath`.
* the `realProjectRelativePath` has been updated accordingly for API
and CLI API docs.
PR Close #26515
2018-10-19 11:12:54 -07:00
Pete Bacon Darwin
9889276b15
build(docs-infra): directive inputs and outputs ( #25768 )
...
PR Close #25768
2018-10-01 09:36:33 -07:00
Pete Bacon Darwin
f22deb2e2d
build(docs-infra): improve directive API doc templates ( #25768 )
...
Closes #22790
Closes #25530
PR Close #25768
2018-10-01 09:36:32 -07:00
Pete Bacon Darwin
3808416479
build(docs-infra): remove legacy jsdoc tag processing ( #26039 )
...
PR Close #26039
2018-09-24 09:11:02 -07:00
Pete Bacon Darwin
7f1cace2a2
build(docs-infra): sort NgModule exports by id ( #26051 )
...
PR Close #26051
2018-09-21 17:00:03 -07:00
Pete Bacon Darwin
56c86c7e79
build(docs-infra): sort package exports by id ( #26051 )
...
Closes #26046
PR Close #26051
2018-09-21 17:00:03 -07:00
Pete Bacon Darwin
026b60cd70
build(docs-infra): expose deprecated status on items more clearly ( #25750 )
...
PR Close #25750
2018-09-21 10:26:48 -07:00
Pete Bacon Darwin
b94436d86c
build(docs-infra): process and render ngmodule exports ( #25734 )
...
All directives and pipes must now be tagged with one ore more
public NgModule, from which they are exported.
If an item is exported transitively via a re-exported internal NgModule
then it may be that the item appears to be exported from more than
one public NgModule. For example, there are shared directives that
are exported in this way from `FormsModule` and `ReactiveFormsModule`.
The doc-gen will error and fail if a directive or pipe is not tagged correctly.
NgModule pages now list all the directives and pipes that are exported from it.
Directive and Pipe pages now list any NgModule from which they are exported.
Packages also now list any NgModules that are contained - previously they were
missed.
PR Close #25734
2018-09-19 16:18:24 -07:00
Pete Bacon Darwin
bc5cb8153e
build(docs-infra): separate NgModules from Classes in API docs ( #25734 )
...
PR Close #25734
2018-09-19 16:18:24 -07:00
Zhicheng Wang
2cd125f40c
docs(API): 改进标题行翻译方式
...
docs(API): 翻译了 directive.ts 中的所有 tsdoc
2018-08-31 09:01:12 +08:00
Pete Bacon Darwin
4e45f2c481
build(docs-infra): include packages in API template breadcrumbs ( #25453 )
...
PR Close #25453
2018-08-14 13:17:15 -07:00
Pete Bacon Darwin
d8c828c9b1
build(docs-infra): implement the 'package' API template ( #24631 )
...
PR Close #24631
2018-07-13 19:45:54 -04:00
Pete Bacon Darwin
cf0968f98e
build(docs-infra): support hiding constructors of injectable classes ( #24529 )
...
Classes that are injectable often have constructors that should not be
called by the application developer. It is the responsibility of the
injector to instantiate the class and the constructor often contains
private implementation details that may need to change.
This commit removes constructors from the docs for API items that are
both:
a) Marked with an injectable decorator (e.g. Injectable, Directive,
Component, Pipe), and
b) Have no constructor description
This second rule allows the developer to override the removal if there
is something useful to say about the constructor.
Note that "normal" classes such as `angimations/HttpHeaders` do not have
their constructor removed, despite (at this time) having no description.
PR Close #24529
2018-06-26 10:58:11 -07:00
Pete Bacon Darwin
8daadf360c
build(aio): compute breadcrums for all API doc types ( #24000 )
...
PR Close #24000
2018-06-13 16:47:40 -07:00
Pete Bacon Darwin
bc4f10ca20
build(aio): rearrange processors to ensure we catch all content errors ( #24000 )
...
PR Close #24000
2018-06-13 16:47:40 -07:00
Pete Bacon Darwin
d4d8125b2d
build(aio): refactor the decorator doc processing ( #24000 )
...
PR Close #24000
2018-06-13 16:47:40 -07:00
Pete Bacon Darwin
9f877f4416
build(docs-infra): ensure stability is computed before the API list ( #24356 )
...
Previously the API list was being generated before the stability had
been computed. This meant that the API list page showed no API docs
when filtering by `stable` stability status.
Closes #24329
PR Close #24356
2018-06-08 13:33:32 -07:00
Pete Bacon Darwin
68d37ef0c1
build(aio): ensure the correct decorator properties are merged ( #24289 )
...
Previously only the `description` and `usageNotes` were being copied over
from the call-member of the decorator interface. Important properties such
as `shortDescription` were missed.
These are now added and the code has been refactored to make it simpler and
clearer to update which properties get copied as the requirements change.
PR Close #24289
2018-06-06 10:23:47 -07:00
Pete Bacon Darwin
a2e8b3a6a8
build(aio): ensure usageNotes are copied into decorator API docs ( #23901 )
...
PR Close #23901
2018-05-14 10:35:33 -07:00
Veres Lajos
de90314304
style: typos fixed - https://github.com/vlajos/misspell-fixer ( #22975 )
...
PR Close #22975
2018-03-27 14:51:53 -04:00
Pete Bacon Darwin
19e6b8dad5
build(aio): fix addNotYetDocumentedProperty processor ( #22770 )
...
It was running too late and so was being confused by the
description being split into `shortDescription` and `description`
properties.
Closes #22748
PR Close #22770
2018-03-15 11:37:31 -07:00
Zhicheng WANG
Kristiyan Kostadinov
George Kalpakas
Pete Bacon Darwin
Adam Plumer
Veres Lajos