From 87994d2c03f7bb243b30352e9123aaee301df0a0 Mon Sep 17 00:00:00 2001 From: Judy Bogart Date: Wed, 13 Nov 2019 08:46:40 -0800 Subject: [PATCH] docs: add api doc to sub-packages (#33801) PR Close #33801 --- packages/animations/browser/PACKAGE.md | 1 + packages/animations/browser/testing/PACKAGE.md | 1 + packages/common/PACKAGE.md | 2 +- packages/common/http/testing/PACKAGE.md | 1 + packages/common/testing/PACKAGE.md | 1 + packages/common/upgrade/PACKAGE.md | 2 ++ packages/core/testing/PACKAGE.md | 1 + packages/platform-browser-dynamic/PACKAGE.md | 1 + packages/platform-browser-dynamic/testing/PACKAGE.md | 1 + packages/platform-browser/animations/PACKAGE.md | 1 + packages/platform-browser/testing/PACKAGE.md | 1 + packages/platform-server/testing/PACKAGE.md | 1 + packages/platform-webworker/PACKAGE.md | 2 ++ packages/upgrade/PACKAGE.md | 7 +++++-- packages/upgrade/static/PACKAGE.md | 2 ++ packages/upgrade/static/testing/PACKAGE.md | 1 + 16 files changed, 23 insertions(+), 3 deletions(-) create mode 100644 packages/animations/browser/PACKAGE.md create mode 100644 packages/animations/browser/testing/PACKAGE.md create mode 100644 packages/common/http/testing/PACKAGE.md create mode 100644 packages/common/testing/PACKAGE.md create mode 100644 packages/common/upgrade/PACKAGE.md create mode 100644 packages/core/testing/PACKAGE.md create mode 100644 packages/platform-browser-dynamic/PACKAGE.md create mode 100644 packages/platform-browser-dynamic/testing/PACKAGE.md create mode 100644 packages/platform-browser/animations/PACKAGE.md create mode 100644 packages/platform-browser/testing/PACKAGE.md create mode 100644 packages/platform-server/testing/PACKAGE.md create mode 100644 packages/platform-webworker/PACKAGE.md create mode 100644 packages/upgrade/static/PACKAGE.md create mode 100644 packages/upgrade/static/testing/PACKAGE.md diff --git a/packages/animations/browser/PACKAGE.md b/packages/animations/browser/PACKAGE.md new file mode 100644 index 0000000000..70ddc83982 --- /dev/null +++ b/packages/animations/browser/PACKAGE.md @@ -0,0 +1 @@ +Provides infrastructure for cross-platform rendering of animations in a browser. \ No newline at end of file diff --git a/packages/animations/browser/testing/PACKAGE.md b/packages/animations/browser/testing/PACKAGE.md new file mode 100644 index 0000000000..c08dfd2f45 --- /dev/null +++ b/packages/animations/browser/testing/PACKAGE.md @@ -0,0 +1 @@ +Provides infrastructure for testing of the Animations browser subsystem. \ No newline at end of file diff --git a/packages/common/PACKAGE.md b/packages/common/PACKAGE.md index 0a0cd68fba..2a95447c3f 100644 --- a/packages/common/PACKAGE.md +++ b/packages/common/PACKAGE.md @@ -1,3 +1,3 @@ -Implements basic Angular directives and pipes, such as NgIf, NgForOf, DecimalPipe, and so on. +Implements fundamental Angular framework functionality, including directives and pipes, location services used in routing, HTTP services, localization support, and so on. The `CommonModule` exports are re-exported by `BrowserModule`, which is included automatically in the root `AppModule` when you create a new app with the CLI `new` command. \ No newline at end of file diff --git a/packages/common/http/testing/PACKAGE.md b/packages/common/http/testing/PACKAGE.md new file mode 100644 index 0000000000..09d82b8eb2 --- /dev/null +++ b/packages/common/http/testing/PACKAGE.md @@ -0,0 +1 @@ +Supplies a testing module for the Angular HTTP subsystem. \ No newline at end of file diff --git a/packages/common/testing/PACKAGE.md b/packages/common/testing/PACKAGE.md new file mode 100644 index 0000000000..c1a2c4d072 --- /dev/null +++ b/packages/common/testing/PACKAGE.md @@ -0,0 +1 @@ +Supplies infrastructure for testing functionality supplied by `@angular/common`. \ No newline at end of file diff --git a/packages/common/upgrade/PACKAGE.md b/packages/common/upgrade/PACKAGE.md new file mode 100644 index 0000000000..033ac73028 --- /dev/null +++ b/packages/common/upgrade/PACKAGE.md @@ -0,0 +1,2 @@ +Provides tools for upgrading from the `$location` service provided in AngularJS +to Angular's [unified location service](guide/upgrade#using-the-unified-angular-location-service). \ No newline at end of file diff --git a/packages/core/testing/PACKAGE.md b/packages/core/testing/PACKAGE.md new file mode 100644 index 0000000000..d9b3a29128 --- /dev/null +++ b/packages/core/testing/PACKAGE.md @@ -0,0 +1 @@ +Provides infrastructure for testing Angular core functionality. \ No newline at end of file diff --git a/packages/platform-browser-dynamic/PACKAGE.md b/packages/platform-browser-dynamic/PACKAGE.md new file mode 100644 index 0000000000..cf1c98655a --- /dev/null +++ b/packages/platform-browser-dynamic/PACKAGE.md @@ -0,0 +1 @@ +Supports [JIT](guide/glossary#jit) compilation and execution of Angular apps on different supported browsers. \ No newline at end of file diff --git a/packages/platform-browser-dynamic/testing/PACKAGE.md b/packages/platform-browser-dynamic/testing/PACKAGE.md new file mode 100644 index 0000000000..f0cb8f0bbc --- /dev/null +++ b/packages/platform-browser-dynamic/testing/PACKAGE.md @@ -0,0 +1 @@ +Supplies a testing module for the Angular JIT platform-browser subsystem. \ No newline at end of file diff --git a/packages/platform-browser/animations/PACKAGE.md b/packages/platform-browser/animations/PACKAGE.md new file mode 100644 index 0000000000..6142b79c32 --- /dev/null +++ b/packages/platform-browser/animations/PACKAGE.md @@ -0,0 +1 @@ +Provides infrastructure for the rendering of animations in supported browsers. \ No newline at end of file diff --git a/packages/platform-browser/testing/PACKAGE.md b/packages/platform-browser/testing/PACKAGE.md new file mode 100644 index 0000000000..cf06cceffe --- /dev/null +++ b/packages/platform-browser/testing/PACKAGE.md @@ -0,0 +1 @@ +Supplies a testing module for the Angular platform-browser subsystem. \ No newline at end of file diff --git a/packages/platform-server/testing/PACKAGE.md b/packages/platform-server/testing/PACKAGE.md new file mode 100644 index 0000000000..d3deb3e2a0 --- /dev/null +++ b/packages/platform-server/testing/PACKAGE.md @@ -0,0 +1 @@ +Supplies a testing module for the Angular platform server subsystem. \ No newline at end of file diff --git a/packages/platform-webworker/PACKAGE.md b/packages/platform-webworker/PACKAGE.md new file mode 100644 index 0000000000..a836130535 --- /dev/null +++ b/packages/platform-webworker/PACKAGE.md @@ -0,0 +1,2 @@ +**Deprecated** This package is deprecated and will be removed in version 10. +See [Angular deprecations policy](guide/deprecations). \ No newline at end of file diff --git a/packages/upgrade/PACKAGE.md b/packages/upgrade/PACKAGE.md index 0074ea39a1..2da14ad53c 100644 --- a/packages/upgrade/PACKAGE.md +++ b/packages/upgrade/PACKAGE.md @@ -1,2 +1,5 @@ -Supports the upgrade path from AngularJS to Angular, allowing -components from both systems to be used in the same application. \ No newline at end of file +Provides support for upgrading applications from Angular JS to Angular. +The primary entry point is deprecated. Use the secondary entry point, + `upgrade/static`. + +See [Angular deprecation policy](guide/deprecations). \ No newline at end of file diff --git a/packages/upgrade/static/PACKAGE.md b/packages/upgrade/static/PACKAGE.md new file mode 100644 index 0000000000..30eb60750c --- /dev/null +++ b/packages/upgrade/static/PACKAGE.md @@ -0,0 +1,2 @@ +Supports the upgrade path from AngularJS to Angular, allowing +components and services from both systems to be used in the same application. \ No newline at end of file diff --git a/packages/upgrade/static/testing/PACKAGE.md b/packages/upgrade/static/testing/PACKAGE.md new file mode 100644 index 0000000000..de7b2b52b1 --- /dev/null +++ b/packages/upgrade/static/testing/PACKAGE.md @@ -0,0 +1 @@ +Supplies testing functions for the AngularJS-to-Angular upgrade path. \ No newline at end of file