From dfdaa157a42550c2049d840bf303553f4cae31ef Mon Sep 17 00:00:00 2001 From: Mike Hartington Date: Tue, 23 Aug 2016 14:13:57 -0400 Subject: [PATCH] docs(screenOrientation): update docs --- src/plugins/screen-orientation.ts | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/src/plugins/screen-orientation.ts b/src/plugins/screen-orientation.ts index bf0579747..9a3d12b10 100644 --- a/src/plugins/screen-orientation.ts +++ b/src/plugins/screen-orientation.ts @@ -22,6 +22,17 @@ declare var window; * ScreenOrientation.unlockOrientation(); * ``` * + * @advanced + * Accepted orientation values: + * | Value | Description | + * |-------------------------------|------------------------------------------------------------------------------| + * | portrait-primary | The orientation is in the primary portrait mode. | + * | portrait-secondary | The orientation is in the secondary portrait mode. | + * | landscape-primary | The orientation is in the primary landscape mode. | + * | landscape-secondary | The orientation is in the secondary landscape mode. | + * | portrait | The orientation is either portrait-primary or portrait-secondary (sensor). | + * | landscape | The orientation is either landscape-primary or landscape-secondary (sensor). | + * */ @Plugin({ plugin: 'cordova-plugin-screen-orientation', @@ -33,17 +44,7 @@ export class ScreenOrientation { /** * Lock the orientation to the passed value. - * - * Accepted orientation values: - * | Value | Description | - * |-------------------------------|------------------------------------------------------------------------------| - * | portrait-primary | The orientation is in the primary portrait mode. | - * | portrait-secondary | The orientation is in the secondary portrait mode. | - * | landscape-primary | The orientation is in the primary landscape mode. | - * | landscape-secondary | The orientation is in the secondary landscape mode. | - * | portrait | The orientation is either portrait-primary or portrait-secondary (sensor). | - * | landscape | The orientation is either landscape-primary or landscape-secondary (sensor). | - * + * See below for accepted values * @param {orientation} The orientation which should be locked. Accepted values see table above. */ @Cordova({ sync: true })