From 2d0eda10e43f6b079b531c507282fad082ea0762 Mon Sep 17 00:00:00 2001 From: Peter Bacon Darwin Date: Wed, 4 Mar 2015 21:25:01 +0000 Subject: [PATCH] docs(ngMessageExp): split ngMessage docs up to show its alias more clearly --- src/ngMessages/messages.js | 34 +++++++++++++++++++++++++++++++--- 1 file changed, 31 insertions(+), 3 deletions(-) diff --git a/src/ngMessages/messages.js b/src/ngMessages/messages.js index 53a1d2822fe9..26fe64e374f0 100644 --- a/src/ngMessages/messages.js +++ b/src/ngMessages/messages.js @@ -537,23 +537,51 @@ angular.module('ngMessages', []) * * ... * ... - * ... * * * * * ... * ... - * ... * * ``` * * {@link module:ngMessages Click here} to learn more about `ngMessages` and `ngMessage`. * * @param {expression} ngMessage|when a string value corresponding to the message key. - * @param {expression} ngMessageExp|whenExp an expression value corresponding to the message key. */ .directive('ngMessage', ngMessageDirectiveFactory('AE')) + + + /** + * @ngdoc directive + * @name ngMessageExp + * @restrict AE + * @scope + * + * @description + * `ngMessageExp` is a directive with the purpose to show and hide a particular message. + * For `ngMessageExp` to operate, a parent `ngMessages` directive on a parent DOM element + * must be situated since it determines which messages are visible based on the state + * of the provided key/value map that `ngMessages` listens on. + * + * @usage + * ```html + * + * + * ... + * + * + * + * + * ... + * + * ``` + * + * {@link module:ngMessages Click here} to learn more about `ngMessages` and `ngMessage`. + * + * @param {expression} ngMessageExp|whenExp an expression value corresponding to the message key. + */ .directive('ngMessageExp', ngMessageDirectiveFactory('A')); function ngMessageDirectiveFactory(restrict) {