From dd64ac557a2948d00d82a2de9e6b3ab3a0c982cc Mon Sep 17 00:00:00 2001 From: Andy Joslin Date: Fri, 28 Mar 2014 07:49:15 -0600 Subject: [PATCH] docs($ionicSideMenuDelegate#getOpenRatio): reword & expand --- js/ext/angular/src/directive/ionicSideMenu.js | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/js/ext/angular/src/directive/ionicSideMenu.js b/js/ext/angular/src/directive/ionicSideMenu.js index e278bf5d7b..ee810a516d 100644 --- a/js/ext/angular/src/directive/ionicSideMenu.js +++ b/js/ext/angular/src/directive/ionicSideMenu.js @@ -77,9 +77,12 @@ angular.module('ionic.ui.sideMenu', ['ionic.service.gesture', 'ionic.service.vie /** * @ngdoc method * @name $ionicSideMenuDelegate#getOpenRatio - * @returns {float} The ratio of open amount over menu width. For example, a - * menu of width 100 open 50 pixels would be open 50% or a ratio of 0.5. Value is negative - * for right menu. + * @description Gets the ratio of open amount over menu width. For example, a + * menu of width 100 that is opened by 50 pixels is 50% opened, and would return + * a ratio of 0.5. + * + * @returns {float} 0 if nothing is open, between 0 and 1 if left menu is + * opened/opening, and between 0 and -1 if right menu is opened/opening. */ 'getOpenRatio', /**