Skip to content
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

Jump to bottom

docs(core) migrate deprecated jsdoc tags #23185

Closed
wants to merge 3 commits into from
Closed

docs(core) migrate deprecated jsdoc tags #23185

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
75e8456
docs(core): migrate deprecated `@howToUse` tags
petebacondarwin Apr 5, 2018
dfcc000
docs(core): migrate `@whatItDoes` tags to the description
petebacondarwin Apr 5, 2018
5e87117
docs(core): remove unnecessary `{@link Injector}` jsdoc tag
petebacondarwin Apr 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 3 additions & 2 deletions packages/core/src/di/injectable.ts
View file
Open in desktop
Expand Up @@ -34,14 +34,15 @@ export type InjectableProvider = ValueSansProvider | ExistingSansProvider |
*/
export interface InjectableDecorator {
/**
* @whatItDoes A marker metadata that marks a class as available to {@link Injector} for creation.
* @howToUse
* @usageNotes
* ```
* @Injectable()
* class Car {}
* ```
*
* @description
* A marker metadata that marks a class as available to {@link Injector} for creation.
*
* For more details, see the {@linkDocs guide/dependency-injection "Dependency Injection Guide"}.
*
* ### Example
Expand Down
6 changes: 4 additions & 2 deletions packages/core/src/di/injector.ts
View file
Open in desktop
Expand Up @@ -39,14 +39,16 @@ export class NullInjector implements Injector {
}

/**
* @whatItDoes Injector interface
* @howToUse
* @usageNotes
* ```
* const injector: Injector = ...;
* injector.get(...);
* ```
*
* @description
*
* Concrete injectors implement this interface.
*
* For more details, see the {@linkDocs guide/dependency-injection "Dependency Injection Guide"}.
*
* ### Example
Expand Down
29 changes: 17 additions & 12 deletions packages/core/src/di/metadata.ts
View file
Open in desktop
Expand Up @@ -20,8 +20,7 @@ import {EMPTY_ARRAY} from '../view/util';
*/
export interface InjectDecorator {
/**
* @whatItDoes A parameter decorator that specifies a dependency.
* @howToUse
* @usageNotes
* ```
* @Injectable()
* class Car {
Expand All @@ -30,6 +29,8 @@ export interface InjectDecorator {
* ```
*
* @description
* A parameter decorator that specifies a dependency.
*
* For more details, see the {@linkDocs guide/dependency-injection "Dependency Injection Guide"}.
*
* ### Example
Expand Down Expand Up @@ -72,9 +73,7 @@ export const Inject: InjectDecorator = makeParamDecorator('Inject', (token: any)
*/
export interface OptionalDecorator {
/**
* @whatItDoes A parameter metadata that marks a dependency as optional.
* {@link Injector} provides `null` if the dependency is not found.
* @howToUse
* @usageNotes
* ```
* @Injectable()
* class Car {
Expand All @@ -83,6 +82,9 @@ export interface OptionalDecorator {
* ```
*
* @description
* A parameter metadata that marks a dependency as optional.
* {@link Injector} provides `null` if the dependency is not found.
*
* For more details, see the {@linkDocs guide/dependency-injection "Dependency Injection Guide"}.
*
* ### Example
Expand Down Expand Up @@ -117,8 +119,7 @@ export const Optional: OptionalDecorator = makeParamDecorator('Optional');
*/
export interface SelfDecorator {
/**
* @whatItDoes Specifies that an {@link Injector} should retrieve a dependency only from itself.
* @howToUse
* @usageNotes
* ```
* @Injectable()
* class Car {
Expand All @@ -127,6 +128,8 @@ export interface SelfDecorator {
* ```
*
* @description
* Specifies that an {@link Injector} should retrieve a dependency only from itself.
*
* For more details, see the {@linkDocs guide/dependency-injection "Dependency Injection Guide"}.
*
* ### Example
Expand Down Expand Up @@ -162,8 +165,7 @@ export const Self: SelfDecorator = makeParamDecorator('Self');
*/
export interface SkipSelfDecorator {
/**
* @whatItDoes Specifies that the dependency resolution should start from the parent injector.
* @howToUse
* @usageNotes
* ```
* @Injectable()
* class Car {
Expand All @@ -172,6 +174,8 @@ export interface SkipSelfDecorator {
* ```
*
* @description
* Specifies that the dependency resolution should start from the parent injector.
*
* For more details, see the {@linkDocs guide/dependency-injection "Dependency Injection Guide"}.
*
* ### Example
Expand Down Expand Up @@ -206,9 +210,7 @@ export const SkipSelf: SkipSelfDecorator = makeParamDecorator('SkipSelf');
*/
export interface HostDecorator {
/**
* @whatItDoes Specifies that an injector should retrieve a dependency from any injector until
* reaching the host element of the current component.
* @howToUse
* @usageNotes
* ```
* @Injectable()
* class Car {
Expand All @@ -217,6 +219,9 @@ export interface HostDecorator {
* ```
*
* @description
* Specifies that an injector should retrieve a dependency from any injector until
* reaching the host element of the current component.
*
* For more details, see the {@linkDocs guide/dependency-injection "Dependency Injection Guide"}.
*
* ### Example
Expand Down