Skip to content

Auto doc #10583

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 2, 2018
Merged

Auto doc #10583

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d1dcbf3
build: update auto-doc to support generate command
clydin May 1, 2018
5763007
docs: update wiki command documentation
clydin May 1, 2018
46be83a
fix(@angular/cli): mark get/set deprecation command as hidden
clydin May 1, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/documentation/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If both the `[key]` and `[value]` are provided it will set the value.
<details>
<summary>global</summary>
<p>
<code>--global</code> (alias: <code>-g</code>)
<code>--global</code> (alias: <code>-g</code>)
</p>
<p>
Get/set the value in the global configuration (in your home directory).
Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<details>
<summary>search</summary>
<p>
<code>--search</code> (alias: <code>-s</code>)
<code>--search</code> (alias: <code>-s</code>)
</p>
<p>
Search whole angular.io instead of just api.
Expand Down
9 changes: 9 additions & 0 deletions docs/documentation/eject.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<!-- Links in /docs/documentation should NOT have \`.md\` at the end, because they end up in our wiki at release. -->

# ng eject

## Overview
Temporarily disabled. Ejects your app and output the proper webpack configuration and scripts.

## Options
None.
4 changes: 2 additions & 2 deletions docs/documentation/generate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<details>
<summary>dry-run</summary>
<p>
<code>--dry-run</code> (alias: <code>-d</code>)
<code>--dry-run</code> (alias: <code>-d</code>)
</p>
<p>
Run through without making any changes.
Expand All @@ -29,7 +29,7 @@
<details>
<summary>force</summary>
<p>
<code>--force</code> (alias: <code>-f</code>)
<code>--force</code> (alias: <code>-f</code>)
</p>
<p>
Forces overwriting of files.
Expand Down
170 changes: 170 additions & 0 deletions docs/documentation/generate/app-shell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,170 @@
<!-- Links in /docs/documentation should NOT have \`.md\` at the end, because they end up in our wiki at release. -->

# ng generate app-shell

## Overview
Create an app shell.

## Options
<details>
<summary>dry-run</summary>
<p>
<code>--dry-run</code> (alias: <code>-d</code>)
</p>
<p>
Run through without making any changes.
</p>
</details>
<details>
<summary>force</summary>
<p>
<code>--force</code> (alias: <code>-f</code>)
</p>
<p>
Forces overwriting of files.
</p>
</details>
<details>
<summary>client-project</summary>
<p>
<code>--client-project</code>
</p>
<p>
Name of related client app.
</p>
</details>
<details>
<summary>universal-project</summary>
<p>
<code>--universal-project</code>
</p>
<p>
Name of related universal app.
</p>
</details>
<details>
<summary>route</summary>
<p>
<code>--route</code>
</p>
<p>
Route path used to produce the app shell.
</p>
</details>
<details>
<summary>name</summary>
<p>
<code>--name</code>
</p>
<p>
Name of the universal app
</p>
</details>
<details>
<summary>app-id</summary>
<p>
<code>--app-id</code>
</p>
<p>
The appId to use withServerTransition.
</p>
</details>
<details>
<summary>out-dir</summary>
<p>
<code>--out-dir</code>
</p>
<p>
The output directory for build results.
</p>
</details>
<details>
<summary>root</summary>
<p>
<code>--root</code>
</p>
<p>
The root directory of the app.
</p>
</details>
<details>
<summary>index</summary>
<p>
<code>--index</code>
</p>
<p>
Name of the index file
</p>
</details>
<details>
<summary>main</summary>
<p>
<code>--main</code>
</p>
<p>
The name of the main entry-point file.
</p>
</details>
<details>
<summary>test</summary>
<p>
<code>--test</code>
</p>
<p>
The name of the test entry-point file.
</p>
</details>
<details>
<summary>tsconfig-file-name</summary>
<p>
<code>--tsconfig-file-name</code>
</p>
<p>
The name of the TypeScript configuration file.
</p>
</details>
<details>
<summary>test-tsconfig-file-name</summary>
<p>
<code>--test-tsconfig-file-name</code>
</p>
<p>
The name of the TypeScript configuration file for tests.
</p>
</details>
<details>
<summary>app-dir</summary>
<p>
<code>--app-dir</code>
</p>
<p>
The name of the application directory.
</p>
</details>
<details>
<summary>root-module-file-name</summary>
<p>
<code>--root-module-file-name</code>
</p>
<p>
The name of the root module file
</p>
</details>
<details>
<summary>root-module-class-name</summary>
<p>
<code>--root-module-class-name</code>
</p>
<p>
The name of the root module class.
</p>
</details>
<details>
<summary>source-dir</summary>
<p>
<code>--source-dir</code> (alias: <code>-D</code>)
</p>
<p>
The path of the source directory.
</p>
</details>
98 changes: 98 additions & 0 deletions docs/documentation/generate/application.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
<!-- Links in /docs/documentation should NOT have \`.md\` at the end, because they end up in our wiki at release. -->

# ng generate application

## Overview
Create an Angular application.

## Options
<details>
<summary>dry-run</summary>
<p>
<code>--dry-run</code> (alias: <code>-d</code>)
</p>
<p>
Run through without making any changes.
</p>
</details>
<details>
<summary>force</summary>
<p>
<code>--force</code> (alias: <code>-f</code>)
</p>
<p>
Forces overwriting of files.
</p>
</details>
<details>
<summary>inline-style</summary>
<p>
<code>--inline-style</code> (alias: <code>-s</code>)
</p>
<p>
Specifies if the style will be in the ts file.
</p>
</details>
<details>
<summary>inline-template</summary>
<p>
<code>--inline-template</code> (alias: <code>-t</code>)
</p>
<p>
Specifies if the template will be in the ts file.
</p>
</details>
<details>
<summary>view-encapsulation</summary>
<p>
<code>--view-encapsulation</code>
</p>
<p>
Specifies the view encapsulation strategy.
</p>
</details>
<details>
<summary>routing</summary>
<p>
<code>--routing</code>
</p>
<p>
Generates a routing module.
</p>
</details>
<details>
<summary>prefix</summary>
<p>
<code>--prefix</code> (alias: <code>-p</code>)
</p>
<p>
The prefix to apply to generated selectors.
</p>
</details>
<details>
<summary>style</summary>
<p>
<code>--style</code>
</p>
<p>
The file extension to be used for style files.
</p>
</details>
<details>
<summary>skip-tests</summary>
<p>
<code>--skip-tests</code> (alias: <code>-S</code>)
</p>
<p>
Skip creating spec files.
</p>
</details>
<details>
<summary>skip-package-json</summary>
<p>
<code>--skip-package-json</code>
</p>
<p>
Do not add dependencies to package.json.
</p>
</details>
34 changes: 30 additions & 4 deletions docs/documentation/generate/class.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,32 @@

## Options
<details>
<summary>app</summary>
<summary>dry-run</summary>
<p>
<code>--app</code> (aliases: <code>-a</code>) <em>default value: 1st app</em>
<code>--dry-run</code> (alias: <code>-d</code>)
</p>
<p>
Specifies app name to use.
Run through without making any changes.
</p>
</details>
<details>
<summary>force</summary>
<p>
<code>--force</code> (alias: <code>-f</code>)
</p>
<p>
Forces overwriting of files.
</p>
</details>
<details>
<summary>project</summary>
<p>
<code>--project</code>
</p>
<p>
The name of the project.
</p>
</details>

<details>
<summary>spec</summary>
<p>
Expand All @@ -25,3 +42,12 @@
Specifies if a spec file is generated.
</p>
</details>
<details>
<summary>type</summary>
<p>
<code>--type</code>
</p>
<p>
Specifies the type of class.
</p>
</details>
Loading