298 Commits

Author SHA1 Message Date
Pete Bacon Darwin
02acb5e3e5 build(aio): improve enum API rendering ()
* 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 

PR Close 
2018-05-14 10:37:42 -07:00
Pete Bacon Darwin
a2e8b3a6a8 build(aio): ensure usageNotes are copied into decorator API docs ()
PR Close 
2018-05-14 10:35:33 -07:00
Pete Bacon Darwin
d889f57ae2 build(aio): display types of API const docs correctly ()
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 
2018-05-11 16:44:50 -04:00
Pete Bacon Darwin
61170856ee build(aio): include navigation.json changes in docs-watch ()
Closes 

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

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

PR Close 
2018-04-17 14:09:02 -07:00
Pete Bacon Darwin
aae437cb1e build(aio): implement rules to prevent short parameter names ()
PR Close 
2018-04-12 00:06:49 -07:00
Pete Bacon Darwin
fa11d7822c build(aio): create minLength content rule ()
This rule can be used to ensure that properties contain a minimum
number of characters.

PR Close 
2018-04-12 00:06:49 -07:00
Pete Bacon Darwin
1619160c8a build(aio): implement rules to prevent headings in content ()
* No headings are allowed in `description` and `shortDescription`
* Only heading level 3 is allowed in `usageNotes`

PR Close 
2018-04-12 00:06:49 -07:00
Pete Bacon Darwin
7a8c58162c build(aio): create noMarkdownHeadings content rule ()
This content rule can check what markdown headings
appear in content properties.

PR Close 
2018-04-12 00:06:49 -07:00
Pete Bacon Darwin
e0ae74d40e build(aio): add checkContentRules processor ()
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 
2018-04-12 00:06:49 -07:00
Pete Bacon Darwin
381da1af45 build(aio): move "optional" and "default" to end of param description ()
PR Close 
2018-04-05 09:25:15 -07:00
Pete Bacon Darwin
5b6e59cfb3 build(aio): fail the doc-gen if the nav is invalid ()
PR Close 
2018-04-04 14:32:14 -07:00
JiaLi.Passion
c560423b52 build: upgrade zone.js ()
PR Close 
2018-04-04 08:24:02 -07:00
Veres Lajos
de90314304 style: typos fixed - https://github.com/vlajos/misspell-fixer ()
PR Close 
2018-03-27 14:51:53 -04:00
Igor Minar
3a30f5d937 build(aio): remove rxjs-compat dependency from examples ()
we should not longer need it.

PR Close 
2018-03-23 12:53:58 -04:00
Igor Minar
0f88fc73db build(aio): update examples to angular-in-memory-web-api@0.6.0 ()
PR Close 
2018-03-23 12:53:58 -04:00
Igor Minar
3cc5c2e4d0 build: update to rxjs@6.0.0-beta.0 ()
PR Close 
2018-03-20 15:26:49 -07:00
Igor Minar
b43f8bc7d3 feat(core): upgrade rxjs to 6.0.0-alpha.4 ()
PR Close 
2018-03-19 21:51:51 -07:00
George Kalpakas
e5fcf650f8 build(aio): temporarily use RxJS from root node_modules/ when using local packages ()
PR Close 
2018-03-19 21:51:51 -07:00
Igor Minar
243c86cd04 ci: improve logging when running aio/examples e2e tests ()
PR Close 
2018-03-18 14:03:26 -07:00
Andrew Seguin
22b96b9690 feat(elements): add support for creating custom elements ()
PR Close 
2018-03-16 12:39:07 -07:00
Pete Bacon Darwin
19e6b8dad5 build(aio): fix addNotYetDocumentedProperty processor ()
It was running too late and so was being confused by the
description being split into `shortDescription` and `description`
properties.

Closes 

PR Close 
2018-03-15 11:37:31 -07:00
Pete Bacon Darwin
d509bd6849 build(aio): improve the API Pipe pages ()
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 
2018-03-14 14:21:11 -07:00
Pete Bacon Darwin
6f0dad1710 build(aio): render doc-gen issues in overview dump ()
Related to 

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

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

PR Close 
2018-03-12 11:23:46 -07:00
Alex Eagle
1e6cc42a01 test: migrate remaining public-api tests to Bazel ()
We now create npm packages to cover all the public api assertions in tools/public_api_guard.
We no longer depend on ts-api-guardian from npm - it is now stale since the repository was archived.
There is no longer a gulp task to enforce or accept the public API, this is in CircleCI as part of running all bazel test targets.

PR Close 
2018-03-09 09:11:40 -08:00
Pete Bacon Darwin
b3d1761825 build(aio): compute and display short descriptions in methods ()
Previously only export docs were displaying a short description.
Now methods in classes and interfaces also compute and render
the short description.

Closes 

PR Close 
2018-03-06 11:05:21 -08:00
Pete Bacon Darwin
8ea4c57174 fix(aio): reposition and shrink the API badges ()
Closes 

PR Close 
2018-03-05 21:25:09 -08:00
Pete Bacon Darwin
58932c7f38 build(aio): indicate whether properties are read-only in API pages ()
PR Close 
2018-03-05 10:15:37 -08:00
Pete Bacon Darwin
5bb9f64218 fixup! feat(aio): allow template to position embedded ToC ()
PR Close 
2018-03-05 10:14:16 -08:00
Pete Bacon Darwin
405d97431f fixup! feat(aio): allow template to position embedded ToC ()
PR Close 
2018-03-05 10:14:16 -08:00
Pete Bacon Darwin
41064fcb36 fix(aio): reposition and simplify github links ()
Closes 

PR Close 
2018-03-05 10:14:16 -08:00
Pete Bacon Darwin
b80fd6be58 build(aio): render whether API classes and members are abstract ()
Closes 

PR Close 
2018-03-05 10:13:43 -08:00
Pete Bacon Darwin
b64139650c build(aio): class API template once again extends export-base ()
PR Close 
2018-03-05 10:12:55 -08:00
Pete Bacon Darwin
1d2bdcb4d0 build(aio): render param descriptions for function exports ()
Closes 

PR Close 
2018-03-05 10:12:55 -08:00
Pete Bacon Darwin
0e311e3918 build(aio): improve accuracy of code auto-linking ()
The new version of `dgeni-packages/typescript` no longer strips
out "namespaces" from types, which was part of the problem of
not autolinking correctly to `HttpEventType.Response`.

Another part of the problem was that we did not include `.`
characters when matching potential code blocks for auto-linking,
which precluded properties of enums from being linked.

Finally, members we not being given a `path` property, which is
needed to effectively autolink to them. This is now set in
the `simplifyMemberAnchors` processor.

Closes 

PR Close 
2018-03-01 08:11:19 -08:00
Pete Bacon Darwin
997b30a093 build(aio): move link disambiguation from getLinkInfo to getDocFromAlias ()
The disambiguation needs to be done earlier so that the auto-link-code
post-processor can benefit from it.

PR Close 
2018-03-01 08:11:19 -08:00
Pete Bacon Darwin
94707fe795 build(aio): initialise exampleMap correctly ()
The `exampleMap` needs to hold an hash object for each
of the `collectExamples.exampleFolders` paths.

Previously these hash objects were only created if there
was actually an example file the hash's respective
example folder.  This could cause crashes during
`yarn docs-watch` (and so also `yarn sync-and-serve`)
if no examples were read in for a particular run of
the doc-gen.

PR Close 
2018-03-01 08:10:15 -08:00
Pete Bacon Darwin
7d65356ae3 build(aio): add @usageNotes tag def for API docs ()
PR Close 
2018-02-28 10:43:27 -08:00