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
4bd9f53e8f
feat(docs-infra): rename tagdef: @experimental to @publicApi ( #26595 )
...
PR Close #26595
2018-10-19 14:35:52 -07: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
46729c76a0
build(docs-infra): improve directive selector rendering ( #25768 )
...
If the documentation contains a `@selectors` tag then the content of that
is used to describe the selectors of a directive.
Otherwise the selector string is split and each selector is listed as
a list item in an unordered list.
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
b8422b41bb
build(docs-infra): fail doc-gen if a content rule fails ( #26039 )
...
PR Close #26039
2018-09-24 09:11:02 -07:00
Pete Bacon Darwin
8ac4dd6447
build(docs-infra): allow usage notes on decorator option properties ( #26039 )
...
PR Close #26039
2018-09-24 09:11:02 -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
cee7448efc
build(docs-infra): add @nocollapse tag-def to prevent warning ( #26039 )
...
See https://github.com/angular/angular/blob/master/packages/compiler-cli/src/transformers/nocollapse_hack.ts
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
9931bd7576
build(docs-infra): do not include license comment in first API doc ( #26050 )
...
The default dgeni config is to concatenate leading comments in front of API items.
In the case that you have an API item that starts a file with no import statements,
the license comment at the top of the file was being added to the front of the
API item's comment. SInce the license comment includes the `@license` tag
and the API item's comment did not start with `@description` the content of
the API item's comment was being put inside the `@license` tag, and no
description was being extracted from the API item's comment.
This commit updates to a version of dgeni-packages that has a switch to turn off
this concatenation, and then also configures this switch.
Closes #26045
PR Close #26050
2018-09-21 10:25:41 -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
62443b04a0
build(aio): do not allow @usageNotes on properties ( #24000 )
...
PR Close #24000
2018-06-13 16:47:40 -07:00
Pete Bacon Darwin
4168c946c6
build(aio): add content rule to prevent usageNotes in non-export API docs ( #24000 )
...
This commit also factors out `API_CONTAINED_DOC_TYPES` to be used by
both `filterContainedDocs` and `addAllowedPropertiesRules`.
PR Close #24000
2018-06-13 16:47:40 -07:00
Pete Bacon Darwin
5fb0b567ce
build(aio): don't render @Annotation tags ( #24000 )
...
Because we were "ignoring" these tags they were being
rendered as part of the previous tag.
What we really want to do is know about them, so that we
don't break the doc-gen but then ignore them when rendering.
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
Zhicheng WANG
Pete Bacon Darwin