From 83e4fc664a2abfefea428c049ff7b0e4ac533335 Mon Sep 17 00:00:00 2001 From: Andy Joslin Date: Mon, 10 Mar 2014 19:50:28 -0600 Subject: [PATCH] docs(ionSideMenu): write docs --- js/ext/angular/src/directive/ionicSideMenu.js | 36 ++++++++++++++----- 1 file changed, 28 insertions(+), 8 deletions(-) diff --git a/js/ext/angular/src/directive/ionicSideMenu.js b/js/ext/angular/src/directive/ionicSideMenu.js index f26d4d7348..34ac1f0273 100644 --- a/js/ext/angular/src/directive/ionicSideMenu.js +++ b/js/ext/angular/src/directive/ionicSideMenu.js @@ -20,21 +20,39 @@ angular.module('ionic.ui.sideMenu', ['ionic.service.gesture', 'ionic.service.vie $ionicViewService.disableRegisterByTagName('ion-side-menus'); }]) +/** + * @ngdoc controller + * @name ionicSideMenus + * @module ionic + * + * @description + * Controller for the {@link ionic.directive:ionSideMenus} directive. + */ +/** + * @ngdoc method + * @name ionicSideMenus#toggleLeft + * @description Toggle the left side menu (if it exists). + */ +/** + * @ngdoc method + * @name ionicSideMenus#toggleRight + * @description Toggle the right side menu (if it exists). + */ + /** * @ngdoc directive * @name ionSideMenus * @module ionic * @restrict E + * @controller ionicSideMenus * * @description - * - * A container element for side menu(s) and the main content. By default, allows the left and/or - * right side menu to be toggled by dragging the main content area side to side. + * A container element for side menu(s) and the main content. Allows the left + * and/or right side menu to be toggled by dragging the main content area side + * to side. * * ![Side Menu](http://ionicframework.com.s3.amazonaws.com/docs/controllers/sidemenu.gif) * - * Exposes `$scope.sideMenuController` on all child scopes, with `toggleLeft()` and `toggleRight()` methods. - * * For more information on side menus, check out the documenation for * {@link ionic.directive:ionSideMenuContent ionSideMenuContent} * {@link ionic.directive:ionSideMenu ionSideMenu}. @@ -67,6 +85,8 @@ angular.module('ionic.ui.sideMenu', ['ionic.service.gesture', 'ionic.service.vie * } * ``` * + * @param {expression=} model The model to assign this side menu container's {@link ionic.controller:ionicSideMenus ionicSideMenus} controller to. By default, assigns to $scope.sideMenuController. + * */ .directive('ionSideMenus', function() { return { @@ -106,7 +126,7 @@ angular.module('ionic.ui.sideMenu', ['ionic.service.gesture', 'ionic.service.vie * * @usage * ```html - *
*
* ``` @@ -229,8 +249,8 @@ angular.module('ionic.ui.sideMenu', ['ionic.service.gesture', 'ionic.service.vie * * @usage * ```html - * *