diff --git a/js/ext/angular/src/directive/ionicNavAnimation.js b/js/ext/angular/src/directive/ionicNavAnimation.js index 70218cd70a..3a652f386a 100644 --- a/js/ext/angular/src/directive/ionicNavAnimation.js +++ b/js/ext/angular/src/directive/ionicNavAnimation.js @@ -1,4 +1,29 @@ angular.module('ionic.ui.navAnimation', []) +/** + * @ngdoc directive + * @name ionNavAnimation + * @module ionic + * @restrict A + * + * @description + * When used under an {@link ionic.directive:ionNavView ionNavView} and on an `` element, + * allows you to set the animation all clicks on that link within the navView use. + * + * @usage + * ```html + * + * + * + * + * Click me and #/some-page will transition in with the slide-in-up animation! + * + * + * + * + * ``` + * + * @param {string} ion-nav-animation The animation to make the parent ionNavView change pages with when clicking this element. + */ .directive('ionNavAnimation', function() { return { restrict: 'A',