Zhicheng WANG
b035e68480
Merge remote-tracking branch 'en/master' into aio
...
# Conflicts:
# .travis.yml
# aio/content/guide/aot-compiler.md
# aio/content/guide/architecture.md
# aio/content/guide/build.md
# aio/content/guide/dependency-injection-in-action.md
# aio/content/guide/deployment.md
# aio/content/guide/elements.md
# aio/content/guide/file-structure.md
# aio/content/guide/glossary.md
# aio/content/guide/hierarchical-dependency-injection.md
# aio/content/guide/lifecycle-hooks.md
# aio/content/guide/ngmodule-faq.md
# aio/content/guide/pipes.md
# aio/content/guide/router.md
# aio/content/guide/rx-library.md
# aio/content/guide/service-worker-communications.md
# aio/content/guide/service-worker-config.md
# aio/content/guide/singleton-services.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/marketing/docs.md
# aio/content/marketing/features.html
# aio/content/tutorial/toh-pt0.md
# aio/content/tutorial/toh-pt6.md
# aio/package.json
# aio/src/app/layout/footer/footer.component.html
# aio/tools/transforms/templates/api/lib/memberHelpers.html
# aio/yarn.lock
# integration/cli-hello-world-ivy-minimal/src/polyfills.ts
# modules/benchmarks/e2e_test/largetable_perf.ts
# modules/benchmarks/e2e_test/largetable_spec.ts
# packages/animations/src/animation_metadata.ts
# packages/common/http/src/headers.ts
# packages/common/http/src/interceptor.ts
# packages/common/src/directives/ng_for_of.ts
# packages/common/src/directives/ng_if.ts
# packages/common/src/directives/ng_style.ts
# packages/common/src/directives/ng_switch.ts
# packages/core/src/change_detection/change_detection_util.ts
# packages/core/src/di/injectable.ts
# packages/core/src/interface/lifecycle_hooks.ts
# packages/core/src/linker/template_ref.ts
# packages/core/src/metadata/di.ts
# packages/core/src/metadata/directives.ts
# packages/core/src/metadata/ng_module.ts
# packages/core/src/render/api.ts
# packages/forms/src/form_providers.ts
# packages/forms/src/model.ts
# packages/router/src/config.ts
# packages/router/src/directives/router_link.ts
2019-02-17 00:00:16 +08:00
Pete Bacon Darwin
cd51775390
build(docs-infra): render @see information in members ( #28069 )
...
Previously `@see` tags were only rendered for top level class-like
docs. Now these tags are rendered for methods and properties too.
PR Close #28069
2019-01-11 14:35:23 -08:00
Zhicheng WANG
22e745af57
fix: 翻译 API 模板
2019-01-04 14:35:16 +08:00
Zhicheng WANG
9a86efc8ea
fix: 翻译 API 模板
2019-01-04 14:33:26 +08: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
Pete Bacon Darwin
18b6d580c5
fix(docs-infra): update overload rendering ( #24976 )
...
Based on the review here:
https://github.com/angular/angular/pull/24976#issuecomment-415535125
PR Close #24976
2018-11-01 14:17:11 -07:00
Pete Bacon Darwin
03417df54e
build(docs-infra): display long overload parameter types as object ( #24976 )
...
In some overloads, the parameter type can be a large anonymous
object type.
This change displays such types as `object`. It is then up to the
documentation author to put more information about the type in the
method usage notes.
PR Close #24976
2018-11-01 14:17:11 -07:00
Pete Bacon Darwin
61cd5f7c0f
build(docs-infra): fix individual API overload templates ( #24976 )
...
* Make individual overloads collapsible
* Show only the first overload expanded, rest collapsed
* Text changes to 'collapse all' once 'show all' is clicked
* Fix chevron/carrot rotation animation when overloads / overload item is expanded or collapsed
PR Close #24976
2018-11-01 14:17:11 -07:00
Pete Bacon Darwin
68dfa04f8a
build(docs-infra): add method overload index ( #24976 )
...
PR Close #24976
2018-11-01 14:17:10 -07:00
Stefanie Fluin
6902977665
build(docs-infra): improve API overload templates ( #24976 )
...
PR Close #24976
2018-11-01 14:17:10 -07:00
Zhicheng Wang
deeeaa9647
docs: 修正坏链
2018-10-22 18:47:41 +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
ea20ae63d0
build(docs-infra): only show name in 'inherited from' section ( #26387 )
...
Closes #26181
PR Close #26387
2018-10-12 09:13:02 -07:00
Pete Bacon Darwin
7373da9b11
build(docs-infra): simplify property syntax rendering ( #25768 )
...
PR Close #25768
2018-10-01 09:36:34 -07:00
Pete Bacon Darwin
783a682a7d
build(docs-infra): remove unused property table heading ( #25768 )
...
PR Close #25768
2018-10-01 09:36:34 -07:00
Pete Bacon Darwin
f4b60588fb
build(docs-infra): move directive macros into memberHelpers.html ( #25768 )
...
PR Close #25768
2018-10-01 09:36:33 -07:00
Pete Bacon Darwin
ce06a75ebf
build(docs-infra): display inherited members on directives ( #25768 )
...
PR Close #25768
2018-10-01 09:36:33 -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
Zhicheng Wang
dd9d8b9363
docs(blog): minor fixes
2018-08-30 09:48:14 +08:00
Pete Bacon Darwin
b1902db0cb
build(docs-infra): render all overloads if they are abstract ( #25670 )
...
In an overloaded method, the overload with the function body is the
actual method doc, and this doc is not included in the list of "additional"
overloads.
Moreover, the logic (all in dgeni-packages) is that if none of the items
has a body then we use the first overload as the actual method doc.
In the case of abstract methods, none of the methods have a body. So we
have a situation where the overloads collection does not contain the first
abstract method, even though it is not the "implementation" of the method.
Therefore we need to still render it.
Closes #25610
PR Close #25670
2018-08-27 18:19:08 -04:00
Zhicheng Wang
cb84b1d1c6
feat: 汉化 API 模板
2018-08-08 15:15:56 +08:00
George Kalpakas
3cd9645daa
fix(docs-infra): fix table header layout in API pages ( #24919 )
...
PR Close #24919
2018-07-20 10:48:42 -07:00
Pete Bacon Darwin
8c51ce6f3b
build(docs-infra): move overload short description above syntax ( #24526 )
...
PR Close #24526
2018-06-25 07:56:36 -07:00
Pete Bacon Darwin
39af314e29
build(aio): add github links to API doc members ( #24000 )
...
This change adds Github edit and view links to methods
and decorator options.
It is possible to add these to properties also but the
UI is rather tight as these are displayed in a table.
PR Close #24000
2018-06-13 16:47:40 -07:00
Pete Bacon Darwin
2b15108f7e
build(aio): remove invalid H3 usage notes heading ( #24000 )
...
This heading is too high for the section because the
method name is a H3 but it cannot be a H4 because
usage notes may contain H4 headings.
PR Close #24000
2018-06-13 16:47:40 -07:00
Pete Bacon Darwin
77309e2ea4
build(aio): map H3 headings into H4 headings for certain templates ( #24000 )
...
The sections such as methods and decorator options are already headed
by a H3 heading so we need to map the H3 headings in the API doc source
down to H4 headings.
This commit includes general heading mapping functionality accessible via
the `marked` Nunjucks filter.
PR Close #24000
2018-06-13 16:47:40 -07:00
Pete Bacon Darwin
02acb5e3e5
build(aio): improve enum API rendering ( #23872 )
...
* The member details section is now called "Members", rather
than "Properties".
* The property table now displays appropriate table headings:
"Member", "Value", "Description".
* The "Value" column is not shown if none of the members have
a value.
Closes #22678
PR Close #23872
2018-05-14 10:37:42 -07:00
Pete Bacon Darwin
b3d1761825
build(aio): compute and display short descriptions in methods ( #22583 )
...
Previously only export docs were displaying a short description.
Now methods in classes and interfaces also compute and render
the short description.
Closes #22500
PR Close #22583
2018-03-06 11:05:21 -08:00
Pete Bacon Darwin
58932c7f38
build(aio): indicate whether properties are read-only in API pages ( #22584 )
...
PR Close #22584
2018-03-05 10:15:37 -08:00
Pete Bacon Darwin
b80fd6be58
build(aio): render whether API classes and members are abstract ( #22563 )
...
Closes #22537
PR Close #22563
2018-03-05 10:13:43 -08:00
George Kalpakas
142117f6bb
fix(aio): do not show Properties/Methods sections if only internal members ( #22471 )
...
PR Close #22471
2018-02-27 15:17:22 -08:00
Pete Bacon Darwin
4bd3e5f92f
build(aio): do not render "constructor()" heading in API docs ( #22380 )
...
Closes #22363
PR Close #22380
2018-02-27 07:07:16 -08:00
Pete Bacon Darwin
1f599818bd
build(aio): fix rendering of callable and constructable interface members ( #22428 )
...
Closes #22136
PR Close #22428
2018-02-26 13:35:15 -08:00
Pete Bacon Darwin
25a43041d2
build(aio): group API members by type in overview ( #22438 )
...
Now the overview groups the members in the following order:
* static properties
* static methods
* constructor
* instance properties
* instance members
Closes #22132
PR Close #22438
2018-02-26 13:34:04 -08:00
Pete Bacon Darwin
7007f51c35
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-09 13:05:16 -08:00
Pete Bacon Darwin
c83c4168ca
build(aio): upgrade to dgeni-packages 0.24.0 ( #21802 )
...
This has two benefits:
* it prepares the way for the API docs update, which need parameter docs
* it doesn't incorrectly report dangling links for non-latin anchors
Closes #21306
PR Close #21802
2018-01-31 10:20:37 -08:00
George Kalpakas
b2e902deb4
fix(aio): fix code highlight in API docs templates ( #21630 )
...
Fixes #21108
PR Close #21630
2018-01-19 13:23:41 -08:00
Peter Bacon Darwin
dbe6cdad7e
build(aio): improve accessor rendering ( #19637 )
...
Includes an update to `dgeni-packages@0.22.0` which provides more info
about accessors if required.
PR Close #19637
2017-10-11 11:51:42 -07:00
Peter Bacon Darwin
9783c92935
build(aio): fix various API rendering issues
...
Upgrading to dgeni-packages 0.21.4 gives us
access to more properties on the API docs, which
allows us to fix the following issues:
Closes #19450
Closes #19452
Closes #19456
2017-10-03 08:15:02 -07:00
Peter Bacon Darwin
35bc1eb218
build(aio): render the extends ancestors of classes in API docs ( #18927 )
...
PR Close #18927
2017-09-05 15:33:10 -05:00
Alex Rickabaugh
db96c963a8
fix(aio): add <hr> in between overloads
2017-07-13 14:58:33 -07:00
Peter Bacon Darwin
f06ce9adc8
build(aio): truncate API overview parameters at one line
2017-07-13 12:16:20 -07:00
Peter Bacon Darwin
be3352a084
build(aio): render grouped overloads
2017-07-13 12:16:20 -07:00
Peter Bacon Darwin
998049ec9b
build(aio): truncate API overview parameters at one line
2017-07-13 12:16:20 -07:00
Peter Bacon Darwin
3abf208235
build(aio): update doc-gen templates
2017-07-11 11:44:05 +01:00
