refactor(delegates): s/getByHandle/$getByHandle for clarity

This commit is contained in:
Andy Joslin
2014-03-24 20:51:14 -06:00
parent 5567b08c4b
commit c6dec3c472
9 changed files with 109 additions and 39 deletions

View File

@@ -29,7 +29,7 @@ angular.module('ionic.ui.sideMenu', ['ionic.service.gesture', 'ionic.service.vie
* Delegate for controlling the {@link ionic.directive:ionSideMenus} directive.
*
* Methods called directly on the $ionicSideMenuDelegate service will control all side
* menus. Use the {@link ionic.service:$ionicSideMenuDelegate#getByHandle getByHandle}
* menus. Use the {@link ionic.service:$ionicSideMenuDelegate#$getByHandle $getByHandle}
* method to control specific ionSideMenus instances.
*
* @usage
@@ -96,13 +96,13 @@ angular.module('ionic.ui.sideMenu', ['ionic.service.gesture', 'ionic.service.vie
'canDragContent',
/**
* @ngdoc method
* @name $ionicSideMenuDelegate#getByHandle
* @name $ionicSideMenuDelegate#$getByHandle
* @param {string} handle
* @returns `delegateInstance` A delegate instance that controls only the
* {@link ionic.directive:ionSideMenus} directives with `delegate-handle` matching
* the given handle.
*
* Example: `$ionicSideMenuDelegate.getByHandle('my-handle').toggleLeft();`
* Example: `$ionicSideMenuDelegate.$getByHandle('my-handle').toggleLeft();`
*/
]))