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

462 Commits

Author SHA1 Message Date
Pete Bacon Darwin
ccb19fea68 build(aio): remove unused @linkDocs alias for @link jsdoc tag (#24000) 
PR Close #24000
 2018-06-13 16:47:40 -07:00
Pete Bacon Darwin
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
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
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
Pete Bacon Darwin
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
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
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
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
thebyteman
fb906a87e8 docs(aio): fix typo (#23925) 
PR Close #23925
 2018-05-22 16:35:17 -04:00
Brandon Roberts
db2329ef6a docs(aio): Add missing dependencies and files to testing zip file download (#23948) 
Closes #23060

PR Close #23948
 2018-05-21 16:12:40 -04:00
Brandon Roberts
20d76374ed docs(aio): Expose server and CLI configuration for universal in guide (#23842) 
Closes #23795

PR Close #23842
 2018-05-16 17:21:44 -04: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
a2e8b3a6a8 build(aio): ensure usageNotes are copied into decorator API docs (#23901) 
PR Close #23901
 2018-05-14 10:35:33 -07:00
Pete Bacon Darwin
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
Pete Bacon Darwin
61170856ee build(aio): include navigation.json changes in docs-watch (#23698) 
Closes #23582

PR Close #23698
 2018-05-09 11:45:18 -07:00
Brandon Roberts
d01ec03f54 docs(aio): Upgrade example dependencies to Angular V6 (#23660) 
PR Close #23660
 2018-05-08 13:56:48 -07:00
Brandon Roberts
9e2d87f5b8 docs(aio): Update i18n example to Angular V6 (#23660) 
PR Close #23660
 2018-05-08 13:56:48 -07:00
Brandon Roberts
2cf6244b1d docs(aio): Upgrade server-side rendering example to Angular V6 (#23649) 
PR Close #23649
 2018-05-02 16:51:03 -07:00
Brandon Roberts
fd9d1888ce build(aio): align stackblitz files with Angular CLI V6 (#23521) 
Also cleans up legacy references to `.angular-cli.json`

PR Close #23521
 2018-05-02 15:00:57 -07:00
Brandon Roberts
fe312ccb4c docs(aio): Cleanup examples with edits from Igor/George (#23234) 
PR Close #23234
 2018-04-17 14:09:02 -07:00
Brandon Roberts
5a2ee7a6f5 docs(aio): Bump shared yarn.lock file for examples (#23234) 
PR Close #23234
 2018-04-17 14:09:02 -07:00
Brandon Roberts
529d4fc9ee docs(aio): Bump shared dependencies to RC5 (#23234) 
PR Close #23234
 2018-04-17 14:09:02 -07:00
Brandon Roberts
1f005908a4 docs(aio): Fix failing boilerplate tests (#23234) 
PR Close #23234
 2018-04-17 14:09:02 -07:00
Brandon Roberts
2278fe8f0e docs(aio): Upgrade examples to Angular 6 (#23234) 
PR Close #23234
 2018-04-17 14:09:02 -07:00
Igor Minar
fc5af69fb2 build(aio): update to @angular/cli@6.0.0-rc.2 + project layout update (#23234) 
project layout was updated using:
yarn ng update @angular/cli --migrate-only --from=1.7.3

PR Close #23234
 2018-04-17 14:09:02 -07:00
Pete Bacon Darwin
aae437cb1e build(aio): implement rules to prevent short parameter names (#22759) 
PR Close #22759
 2018-04-12 00:06:49 -07:00
Pete Bacon Darwin
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
Pete Bacon Darwin
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
Pete Bacon Darwin
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
Pete Bacon Darwin
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
Pete Bacon Darwin
381da1af45 build(aio): move "optional" and "default" to end of param description (#23062) 
PR Close #23062
 2018-04-05 09:25:15 -07:00
Pete Bacon Darwin
5b6e59cfb3 build(aio): fail the doc-gen if the nav is invalid (#23175) 
PR Close #23175
 2018-04-04 14:32:14 -07:00
JiaLi.Passion
c560423b52 build: upgrade zone.js (#23108) 
PR Close #23108
 2018-04-04 08:24:02 -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
Igor Minar
3a30f5d937 build(aio): remove rxjs-compat dependency from examples (#22872) 
we should not longer need it.

PR Close #22872
 2018-03-23 12:53:58 -04:00
Igor Minar
0f88fc73db build(aio): update examples to angular-in-memory-web-api@0.6.0 (#22872) 
PR Close #22872
 2018-03-23 12:53:58 -04:00
Igor Minar
3cc5c2e4d0 build: update to rxjs@6.0.0-beta.0 (#22887) 
PR Close #22887
 2018-03-20 15:26:49 -07:00
Igor Minar
b43f8bc7d3 feat(core): upgrade rxjs to 6.0.0-alpha.4 (#22573) 
PR Close #22573
 2018-03-19 21:51:51 -07:00
George Kalpakas
e5fcf650f8 build(aio): temporarily use RxJS from root node_modules/ when using local packages (#22573) 
PR Close #22573
 2018-03-19 21:51:51 -07:00
Igor Minar
243c86cd04 ci: improve logging when running aio/examples e2e tests (#22854) 
PR Close #22854
 2018-03-18 14:03:26 -07:00
Andrew Seguin
22b96b9690 feat(elements): add support for creating custom elements (#22413) 
PR Close #22413
 2018-03-16 12:39:07 -07: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
Pete Bacon Darwin
d509bd6849 build(aio): improve the API Pipe pages (#22702) 
This change adds:

* an impure badge for Pipes that are marked as  `pure: false`
* a pipe specific overview that shows the syntax for using a pipe in a template.
* an "input value" section describing the type of the value that the pipe expects.
* a "pipe params" section describing any additional params that a pipe expects.

PR Close #22702
 2018-03-14 14:21:11 -07:00
Pete Bacon Darwin
6f0dad1710 build(aio): render doc-gen issues in overview dump (#22675) 
Related to #22138

PR Close #22675
 2018-03-14 10:20:30 -07:00
Pete Bacon Darwin
48636f3e85 build(aio): compute stability and deprecate @stable tag (#22674) 
Closes #22635

PR Close #22674
 2018-03-13 19:55:00 -07:00
Pete Bacon Darwin
cd58c0a6d9 build(aio): remove unwanted overview headings (#22681) 
PR Close #22681
 2018-03-12 11:23:47 -07:00
Pete Bacon Darwin
38fef1588d build(aio): move "see also" block to export-base template (#22681) 
This makes it easier for all the API docs to display "see also" links
in a consitent manner.

PR Close #22681
 2018-03-12 11:23:46 -07:00