e436d6972b
docs(API): 翻译完了几个表单控件类
2018-09-01 09:19:36 +08:00
2cd125f40c
docs(API): 改进标题行翻译方式
...
docs(API): 翻译了 directive.ts 中的所有 tsdoc
2018-08-31 09:01:12 +08:00
dd9d8b9363
docs(blog): minor fixes
2018-08-30 09:48:14 +08:00
54a47e84dc
fix: 文字微调
2018-08-08 15:32:37 +08:00
d3f9534441
fix: point to angular.cn
2018-08-08 15:27:40 +08:00
cb84b1d1c6
feat: 汉化 API 模板
2018-08-08 15:15:56 +08:00
2d485c6589
Merge remote-tracking branch 'en/master' into aio
...
# Conflicts:
# aio/content/guide/animations.md
# aio/content/guide/aot-compiler.md
# aio/content/guide/api-page-class.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/browser-support.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/elements.md
# aio/content/guide/form-validation.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/language-service.md
# aio/content/guide/lifecycle-hooks.md
# aio/content/guide/ngmodule-api.md
# aio/content/guide/ngmodule-faq.md
# aio/content/guide/npm-packages.md
# aio/content/guide/observables.md
# aio/content/guide/pipes.md
# aio/content/guide/providers.md
# aio/content/guide/quickstart.md
# aio/content/guide/reactive-forms.md
# aio/content/guide/releases.md
# aio/content/guide/router.md
# aio/content/guide/rx-library.md
# aio/content/guide/security.md
# aio/content/guide/service-worker-config.md
# aio/content/guide/service-worker-getting-started.md
# aio/content/guide/set-document-title.md
# aio/content/guide/setup.md
# aio/content/guide/structural-directives.md
# aio/content/guide/styleguide.md
# aio/content/guide/template-syntax.md
# aio/content/guide/testing-observables.md
# aio/content/guide/testing.md
# aio/content/guide/typescript-configuration.md
# aio/content/guide/universal.md
# aio/content/guide/upgrade.md
# aio/content/guide/user-input.md
# aio/content/guide/visual-studio-2015.md
# aio/content/guide/webpack.md
# aio/content/marketing/resources.json
# aio/content/navigation.json
# aio/content/tutorial/toh-pt0.md
# aio/content/tutorial/toh-pt1.md
# aio/content/tutorial/toh-pt4.md
# aio/content/tutorial/toh-pt5.md
# aio/content/tutorial/toh-pt6.md
# aio/src/app/custom-elements/api/api-list.component.ts
# aio/src/app/custom-elements/live-example/live-example.component.html
# aio/src/app/custom-elements/live-example/live-example.component.ts
# aio/src/app/layout/doc-viewer/doc-viewer.component.ts
# aio/src/styles/main.scss
# aio/tools/transforms/remark-package/services/renderMarkdown.js
2018-07-27 10:51:18 +08:00
edef58f466
build(docs-infra): ensure all API headings are sentence cased ( #24949 )
...
Closes #24880
PR Close #24949
2018-07-23 08:43:07 -07:00
3cd9645daa
fix(docs-infra): fix table header layout in API pages ( #24919 )
...
PR Close #24919
2018-07-20 10:48:42 -07:00
d8c828c9b1
build(docs-infra): implement the 'package' API template ( #24631 )
...
PR Close #24631
2018-07-13 19:45:54 -04:00
d876700c26
build(docs-infra): render short description of parameters in API docs ( #24537 )
...
PR Close #24537
2018-06-28 15:03:14 -07:00
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
8c51ce6f3b
build(docs-infra): move overload short description above syntax ( #24526 )
...
PR Close #24526
2018-06-25 07:56:36 -07:00
45862d0812
build(docs-infra): ensure all headings are sentence cased ( #24527 )
...
PR Close #24527
2018-06-15 09:13:45 -07:00
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
8daadf360c
build(aio): compute breadcrums for all API doc types ( #24000 )
...
PR Close #24000
2018-06-13 16:47:40 -07:00
859a3d5784
build(aio): fix decorator doc "inherited from" heading ( #24000 )
...
We should not include the package path in the inherited
from heading for decorator API docs
PR Close #24000
2018-06-13 16:47:40 -07:00
8a4c577917
build(aio): fix broken doc-gen unit test ( #24000 )
...
PR Close #24000
2018-06-13 16:47:40 -07:00
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
bc4f10ca20
build(aio): rearrange processors to ensure we catch all content errors ( #24000 )
...
PR Close #24000
2018-06-13 16:47:40 -07:00
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
e371b226fa
build(aio): rearrange decorator API doc template ( #24000 )
...
The overview of the decorator options is now a table.
The detailed description of each option is now a full section.
PR Close #24000
2018-06-13 16:47:40 -07:00
ccb19fea68
build(aio): remove unused `@linkDocs` alias for `@link` jsdoc tag ( #24000 )
...
PR Close #24000
2018-06-13 16:47:40 -07:00
e7b392bf3a
build(aio): improve automatic linking of code items ( #24000 )
...
This commit adds new link disambiguators that mean that more
code links can be generated automatically in a sensible way.
The best example is the use of properties within class, interface and
enum documentation.
PR Close #24000
2018-06-13 16:47:40 -07:00
d4d8125b2d
build(aio): refactor the decorator doc processing ( #24000 )
...
PR Close #24000
2018-06-13 16:47:40 -07:00
62443b04a0
build(aio): do not allow `@usageNotes` on properties ( #24000 )
...
PR Close #24000
2018-06-13 16:47:40 -07:00
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
293ec78069
build(aio): don't constrain `checkContentRules` to run before another processor ( #24000 )
...
We don't really care when this processor runs as long as it happens
after the tags have been extracted.
By not constraining its `runBefore` property we can ensure that other
processors can be run before it.
PR Close #24000
2018-06-13 16:47:40 -07:00
131d0d8e8a
build(aio): do not try to auto-link to internal API items ( #24000 )
...
This would cause dangling links since the target, being internal,
would not exist in the docs.
PR Close #24000
2018-06-13 16:47:40 -07:00
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
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
700e55ce14
build(docs-infra): log warning rather than error if content errors are not fatal ( #24320 )
...
PR Close #24320
2018-06-06 10:25:04 -07:00
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
8136953a09
Merge branch 'en-master' into aio
...
# Conflicts:
# aio/content/examples/dynamic-component-loader/src/app/ad-banner.component.ts
# aio/content/examples/reactive-forms/src/app/hero-list/hero-list.component.ts
# aio/content/examples/upgrade-module/src/systemjs.config.1.js
# 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/bootstrapping.md
# aio/content/guide/cheatsheet.md
# aio/content/guide/comparing-observables.md
# aio/content/guide/component-styles.md
# aio/content/guide/dependency-injection-in-action.md
# aio/content/guide/dependency-injection.md
# aio/content/guide/deployment.md
# aio/content/guide/docs-style-guide.md
# aio/content/guide/dynamic-component-loader.md
# aio/content/guide/elements.md
# aio/content/guide/glossary.md
# aio/content/guide/hierarchical-dependency-injection.md
# aio/content/guide/http.md
# aio/content/guide/lifecycle-hooks.md
# aio/content/guide/ngmodule-faq.md
# aio/content/guide/npm-packages.md
# aio/content/guide/observables.md
# aio/content/guide/providers.md
# aio/content/guide/quickstart.md
# aio/content/guide/reactive-forms.md
# aio/content/guide/releases.md
# aio/content/guide/router.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/setup.md
# aio/content/guide/singleton-services.md
# aio/content/guide/styleguide.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/marketing/features.html
# aio/content/navigation.json
# aio/content/tutorial/toh-pt0.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/documents/document.service.ts
# aio/src/app/layout/doc-viewer/doc-viewer.component.ts
# aio/src/app/shared/toc.service.ts
# aio/tools/transforms/templates/api/base.template.html
# aio/yarn.lock
2018-05-15 23:26:31 +08:00
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
a2e8b3a6a8
build(aio): ensure usageNotes are copied into decorator API docs ( #23901 )
...
PR Close #23901
2018-05-14 10:35:33 -07:00
d889f57ae2
build(aio): display types of API const docs correctly ( #23850 )
...
Previously these docs always displayed `any` as the type
of the const export. Now the type is computed correctly from
the declared type or initializer of the constant.
PR Close #23850
2018-05-11 16:44:50 -04:00
61170856ee
build(aio): include `navigation.json` changes in docs-watch ( #23698 )
...
Closes #23582
PR Close #23698
2018-05-09 11:45:18 -07:00
aae437cb1e
build(aio): implement rules to prevent short parameter names ( #22759 )
...
PR Close #22759
2018-04-12 00:06:49 -07:00
fa11d7822c
build(aio): create minLength content rule ( #22759 )
...
This rule can be used to ensure that properties contain a minimum
number of characters.
PR Close #22759
2018-04-12 00:06:49 -07:00
1619160c8a
build(aio): implement rules to prevent headings in content ( #22759 )
...
* No headings are allowed in `description` and `shortDescription`
* Only heading level 3 is allowed in `usageNotes`
PR Close #22759
2018-04-12 00:06:49 -07:00
7a8c58162c
build(aio): create noMarkdownHeadings content rule ( #22759 )
...
This content rule can check what markdown headings
appear in content properties.
PR Close #22759
2018-04-12 00:06:49 -07:00
e0ae74d40e
build(aio): add checkContentRules processor ( #22759 )
...
This processor will enable us to write rules about
how the content should appear, such as:
* no headings in markdown content
* only one sentence per line
* no single character parameter names
* etc.
PR Close #22759
2018-04-12 00:06:49 -07:00
381da1af45
build(aio): move "optional" and "default" to end of param description ( #23062 )
...
PR Close #23062
2018-04-05 09:25:15 -07:00
5b6e59cfb3
build(aio): fail the doc-gen if the nav is invalid ( #23175 )
...
PR Close #23175
2018-04-04 14:32:14 -07:00
de90314304
style: typos fixed - https://github.com/vlajos/misspell-fixer ( #22975 )
...
PR Close #22975
2018-03-27 14:51:53 -04:00
b433d2148c
fix: change some angular.io to angular.cn
2018-03-26 16:34:57 +08:00
67cb21e6c1
fix: 翻译完了服务端渲染部分
2018-03-22 10:52:52 +08:00
22b96b9690
feat(elements): add support for creating custom elements ( #22413 )
...
PR Close #22413
2018-03-16 12:39:07 -07:00
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
Pete Bacon Darwin
George Kalpakas
Veres Lajos
Andrew Seguin