cargdev/angular
1
0
Fork 0
Code Issues 9 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(common): migrate @whatItDoes tags to the description (#23062)

Browse Source 
We get the overview for the doc by splitting off the first
paragraph.

PR Close #23062
This commit is contained in:
Pete Bacon Darwin
2018-03-29 11:12:34 +01:00
committed by Igor Minar
parent 46ba7f69dd
commit 079d8e57d5
20 changed files with 58 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
packages/common/src/location/hash_location_strategy.ts
View File

@ -16,10 +16,9 @@ import {LocationChangeListener, PlatformLocation} from './platform_location';
/**
* @whatItDoes Use URL hash for storing application location data.
* @description
* `HashLocationStrategy` is a {@link LocationStrategy} used to configure the
* {@link Location} service to represent its state in the
* A {@link LocationStrategy} used to configure the {@link Location} service to
* represent its state in the
* [hash fragment](https://en.wikipedia.org/wiki/Uniform_Resource_Locator#Syntax)
* of the browser's URL.
*

4
packages/common/src/location/location.ts
View File

@ -20,8 +20,10 @@ export interface PopStateEvent {
}
/**
* @whatItDoes `Location` is a service that applications can use to interact with a browser's URL.
* @description
*
* A service that applications can use to interact with a browser's URL.
*
* Depending on which {@link LocationStrategy} is used, `Location` will either persist
* to the URL's path or the URL's hash segment.
*

5
packages/common/src/location/path_location_strategy.ts
View File

@ -16,10 +16,9 @@ import {LocationChangeListener, PlatformLocation} from './platform_location';
/**
* @whatItDoes Use URL for storing application location data.
* @description
* `PathLocationStrategy` is a {@link LocationStrategy} used to configure the
* {@link Location} service to represent its state in the
* A {@link LocationStrategy} used to configure the {@link Location} service to
* represent its state in the
* [path](https://en.wikipedia.org/wiki/Uniform_Resource_Locator#Syntax) of the
* browser's URL.
*

5
packages/common/src/location/platform_location.ts
View File

@ -48,13 +48,14 @@ export abstract class PlatformLocation {
}
/**
* @whatItDoes indicates when a location is initialized
* @description Indicates when a location is initialized.
* @experimental
*/
export const LOCATION_INITIALIZED = new InjectionToken<Promise<any>>('Location Initialized');
/**
* A serializable version of the event from onPopState or onHashChange
* @description
* A serializable version of the event from `onPopState` or `onHashChange`
*
* @experimental
*/