docs(all): standardizes and adds return types, also some param fixes

This commit is contained in:
Alex Muramoto
2016-11-29 16:40:50 -06:00
parent b7a562053a
commit 3da2831779
88 changed files with 635 additions and 347 deletions
+22
View File
@@ -107,12 +107,14 @@ export class LaunchNavigator {
/**
* Determines if the given app is installed and available on the current device.
* @param app {string}
* @returns {Promise<any>}
*/
@Cordova()
static isAppAvailable(app: string): Promise<any> { return; }
/**
* Returns a list indicating which apps are installed and available on the current device.
* @returns {Promise<string[]>}
*/
@Cordova()
static availableApps(): Promise<string[]> { return; }
@@ -120,6 +122,7 @@ export class LaunchNavigator {
/**
* Returns the display name of the specified app.
* @param app {string}
* @returns {string}
*/
@Cordova({ sync: true })
static getAppDisplayName(app: string): string { return; }
@@ -127,6 +130,7 @@ export class LaunchNavigator {
/**
* Returns list of supported apps on a given platform.
* @param platform {string}
* @returns {string[]}
*/
@Cordova({ sync: true })
static getAppsForPlatform(platform: string): string[] { return; }
@@ -135,6 +139,7 @@ export class LaunchNavigator {
* Indicates if an app on a given platform supports specification of transport mode.
* @param app {string} specified as a string, you can use one of the constants, e.g `LaunchNavigator.APP.GOOGLE_MAPS`
* @param platform {string}
* @returns {boolean}
*/
@Cordova({ sync: true })
static supportsTransportMode(app: string, platform: string): boolean { return; }
@@ -143,6 +148,7 @@ export class LaunchNavigator {
* Returns the list of transport modes supported by an app on a given platform.
* @param app {string}
* @param platform {string}
* @returns {string[]}
*/
@Cordova({ sync: true })
static getTransportModes(app: string, platform: string): string[] { return; }
@@ -152,6 +158,7 @@ export class LaunchNavigator {
* Note that currently only Google Maps on Android does.
* @param app {string}
* @param platform {string}
* @returns {boolean}
*/
@Cordova({ sync: true })
static supportsLaunchMode(app: string, platform: string): boolean { return; }
@@ -160,16 +167,31 @@ export class LaunchNavigator {
* Indicates if an app on a given platform supports specification of start location.
* @param app {string}
* @param platform {string}
* @returns {boolean}
*/
@Cordova({ sync: true })
static supportsStart(app: string, platform: string): boolean { return; }
/**
* @param app {string}
* @param platform {string}
* @returns {boolean}
*/
@Cordova({ sync: true })
static supportsStartName(app: string, platform: string): boolean { return; }
/**
* @param app {string}
* @param platform {string}
* @returns {boolean}
*/
@Cordova({ sync: true })
static supportsDestName(app: string, platform: string): boolean { return; }
/**
* @param destination {string | number[]}
* @param options {LaunchNavigatorOptions}
*/
@Cordova({ sync: true })
static userSelect(destination: string | number[], options: LaunchNavigatorOptions): void { }