diff --git a/src/plugins/devicemotion.ts b/src/plugins/devicemotion.ts index 5fa1b651d..1b8036fb5 100644 --- a/src/plugins/devicemotion.ts +++ b/src/plugins/devicemotion.ts @@ -1,7 +1,7 @@ import { Cordova, Plugin } from './plugin'; import { Observable } from 'rxjs/Observable'; -export interface AccelerationData { +export interface DeviceMotionAccelerationData { /** * Amount of acceleration on the x-axis. (in m/s^2) @@ -25,7 +25,7 @@ export interface AccelerationData { } -export interface AccelerometerOptions { +export interface DeviceMotionAccelerometerOptions { /** * Requested period of calls to accelerometerSuccess with acceleration data in Milliseconds. Default: 10000 @@ -59,6 +59,9 @@ export interface AccelerometerOptions { * subscription.unsubscribe(); * * ``` + * @interfaces + * DeviceMotionAccelerationData + * DeviceMotionAccelerometerOptions */ @Plugin({ pluginName: 'DeviceMotion', @@ -70,21 +73,21 @@ export class DeviceMotion { /** * Get the current acceleration along the x, y, and z axes. - * @returns {Promise} Returns object with x, y, z, and timestamp properties + * @returns {Promise} Returns object with x, y, z, and timestamp properties */ @Cordova() - static getCurrentAcceleration(): Promise { return; } + static getCurrentAcceleration(): Promise { return; } /** * Watch the device acceleration. Clear the watch by unsubscribing from the observable. * @param {AccelerometerOptions} options list of options for the accelerometer. - * @returns {Observable} Observable returns an observable that you can subscribe to + * @returns {Observable} Observable returns an observable that you can subscribe to */ @Cordova({ callbackOrder: 'reverse', observable: true, clearFunction: 'clearWatch' }) - static watchAcceleration(options?: AccelerometerOptions): Observable { return; } + static watchAcceleration(options?: DeviceMotionAccelerometerOptions): Observable { return; } }