docs($ionicSideMenuDelegate#getOpenRatio): reword & expand

This commit is contained in:
Andy Joslin
2014-03-28 07:49:15 -06:00
parent ac0e981f9e
commit dd64ac557a

View File

@@ -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',
/**