iSharkFly-Docs/angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
13,691 Commits 5 Branches 1 Tag
Commit Graph

322 Commits

Author SHA1 Message Date
Pete Bacon Darwin
5977b72e9c build(docs-infra): fix formatting of entry point export table (#25768) 
Now that `list-table` cells are `pre` formatterd we must be careful
of what whitespace appears in text nodes.

PR Close #25768
 2018-10-01 09:36:34 -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
d22418d417 build(docs-infra): add short description "See more" link (#25768) 
If there is additional (non-short) description then add in a
link to the short description to take the reader there.

PR Close #25768
 2018-10-01 09:36:34 -07:00
Pete Bacon Darwin
4b1fd98093 build(docs-infra): pluralize NgModule(s) heading as appropriate (#25768) 
PR Close #25768
 2018-10-01 09:36:34 -07:00
Pete Bacon Darwin
935ef13096 build(docs-infra): improve directive selector rendering (#25768) 
`:not(...)` blocks are now rendered as italic, while the
rest of the selector is bold.

PR Close #25768
 2018-10-01 09:36:33 -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
15dadb92ef build(docs-infra): include directives etc in class descendants lists (#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
Pete Bacon Darwin
d0f7eadc09 build(docs-infra): rename example template variable in directive pages (#25768) 
PR Close #25768
 2018-10-01 09:36:33 -07:00
Pete Bacon Darwin
4b132c9848 build(docs-infra): remove class overview from directive pages (#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
f29b218060 feat(docs-infra): generate Angular CLI command reference (#25363) 
PR Close #25363
 2018-09-26 11:24:02 -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
cea2e0477c fix(docs-infra): render security risk labels (#25750) 
PR Close #25750
 2018-09-21 10:26:48 -07:00
Pete Bacon Darwin
96f9f03d25 build(docs-infra): improve search quality (#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
Pete Bacon Darwin
34b848ad51 build(docs-infra): remove unused info-bar API template (#25734) 
PR Close #25734
 2018-09-19 16:18:24 -07:00
Pete Bacon Darwin
4a04ab8823 build(docs-infra): do not render internals in package API pages (#25723) 
Closes #24493

PR Close #25723
 2018-09-05 09:28:05 -07:00
Zhicheng Wang
e436d6972b docs(API): 翻译完了几个表单控件类 2018-09-01 09:19:36 +08:00
Martin Sikora
d539122466 refactor(docs-infra): refactor templates (#24378) 
PR Close #24378
 2018-08-31 09:42:10 -07:00
Martin Sikora
b89a7dd4a2 fix(docs-infra): show "suggest edits" only for /guide and /tutorial dirs (#24378) 
PR Close #24378
 2018-08-31 09:42:10 -07:00
Martin Sikora
9533cc9809 feat(docs-infra): add "suggest edits" feature to all docs (#24378) 
PR Close #24378
 2018-08-31 09:42:10 -07:00
Zhicheng Wang
2cd125f40c docs(API): 改进标题行翻译方式 
docs(API): 翻译了 directive.ts 中的所有 tsdoc
 2018-08-31 09:01:12 +08: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
Pete Bacon Darwin
a081d207f8 build(docs-infra): remove "annotations" section from API pages (#25677) 
PR Close #25677
 2018-08-27 18:18:41 -04:00
Pete Bacon Darwin
c13901f4c8 build(docs-infra): remove stability labels from API docs (#25453) 
PR Close #25453
 2018-08-14 13:17:15 -07:00
Pete Bacon Darwin
6a2130117f build(docs-infra): clean up API package template (#25453) 
PR Close #25453
 2018-08-14 13:17:15 -07: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
78f477652e build(docs-infra): change breadcrumb delimiter to > (#25453) 
PR Close #25453
 2018-08-14 13:17:15 -07:00
Zhicheng Wang
54a47e84dc fix: 文字微调 2018-08-08 15:32:37 +08:00
Zhicheng Wang
d3f9534441 fix: point to angular.cn 2018-08-08 15:27:40 +08:00
Zhicheng Wang
cb84b1d1c6 feat: 汉化 API 模板 2018-08-08 15:15:56 +08:00
Zhicheng Wang
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
Pete Bacon Darwin
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
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
d8c828c9b1 build(docs-infra): implement the 'package' API template (#24631) 
PR Close #24631
 2018-07-13 19:45:54 -04:00
Pete Bacon Darwin
d876700c26 build(docs-infra): render short description of parameters in API docs (#24537) 
PR Close #24537
 2018-06-28 15:03:14 -07: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