From e0cc84ad7b7cdeb22cc56a75ab0775b90791da06 Mon Sep 17 00:00:00 2001
From: Igor Minar
Date: Fri, 9 Mar 2012 15:18:57 -0800
Subject: docs(directives): set directive param name to directive name
so that we can render better usage examples in docs
---
src/directive/ngBind.js | 10 +++++-----
src/directive/ngClass.js | 12 ++++++------
src/directive/ngController.js | 2 +-
src/directive/ngEventDirs.js | 18 +++++++++---------
src/directive/ngInit.js | 2 +-
src/directive/ngRepeat.js | 2 +-
src/directive/ngShowHide.js | 4 ++--
src/directive/ngStyle.js | 2 +-
8 files changed, 26 insertions(+), 26 deletions(-)
(limited to 'src')
diff --git a/src/directive/ngBind.js b/src/directive/ngBind.js
index 4f443328..cf9b5688 100644
--- a/src/directive/ngBind.js
+++ b/src/directive/ngBind.js
@@ -14,7 +14,7 @@
* `` when the template is compiled.
*
* @element ANY
- * @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate.
+ * @param {expression} ng-bind {@link guide/dev_guide.expressions Expression} to evaluate.
*
* @example
* Enter a name in the Live Preview text box; the greeting below the text box changes instantly.
@@ -60,7 +60,7 @@ var ngBindDirective = ngDirective(function(scope, element, attr) {
* See {@link angular.module.ng.$sanitize $sanitize} docs for examples.
*
* @element ANY
- * @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate.
+ * @param {expression} ng-bind-html-unsafe {@link guide/dev_guide.expressions Expression} to evaluate.
*/
var ngBindHtmlUnsafeDirective = ngDirective(function(scope, element, attr) {
element.addClass('ng-binding').data('$binding', attr.ngBindHtmlUnsafe);
@@ -82,7 +82,7 @@ var ngBindHtmlUnsafeDirective = ngDirective(function(scope, element, attr) {
* See {@link angular.module.ng.$sanitize $sanitize} docs for examples.
*
* @element ANY
- * @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate.
+ * @param {expression} ng-bind-html {@link guide/dev_guide.expressions Expression} to evaluate.
*/
var ngBindHtmlDirective = ['$sanitize', function($sanitize) {
return function(scope, element, attr) {
@@ -108,7 +108,7 @@ var ngBindHtmlDirective = ['$sanitize', function($sanitize) {
* can not have SPAN elements such as TITLE, or OPTION to name a few.)
*
* @element ANY
- * @param {string} template of form
+ * @param {string} ng-bind-template template of form
* {{ expression }} to eval.
*
* @example
@@ -191,7 +191,7 @@ var ngBindTemplateDirective = ['$interpolate', function($interpolate) {
*
*
* @element ANY
- * @param {string} attribute_json one or more JSON key-value pairs representing
+ * @param {string} ng-bind-attr one or more JSON key-value pairs representing
* the attributes to replace with expressions. Each key matches an attribute
* which needs to be replaced. Each value is a text template of
* the attribute with the embedded
diff --git a/src/directive/ngClass.js b/src/directive/ngClass.js
index 903625e6..21b75dd0 100644
--- a/src/directive/ngClass.js
+++ b/src/directive/ngClass.js
@@ -31,7 +31,7 @@ function classDirective(name, selector) {
* new classes are added.
*
* @element ANY
- * @param {expression} expression {@link guide/dev_guide.expressions Expression} to eval. The result
+ * @param {expression} ng-class {@link guide/dev_guide.expressions Expression} to eval. The result
* of the evaluation can be a string representing space delimited class
* names, an array, or a map of class names to boolean values.
*
@@ -76,7 +76,7 @@ var ngClassDirective = classDirective('', true);
* {@link angular.module.ng.$compileProvider.directive.ng-repeat ng-repeat}.
*
* @element ANY
- * @param {expression} expression {@link guide/dev_guide.expressions Expression} to eval. The result
+ * @param {expression} ng-class-odd {@link guide/dev_guide.expressions Expression} to eval. The result
* of the evaluation can be a string representing space delimited class names or an array.
*
* @example
@@ -109,15 +109,15 @@ var ngClassOddDirective = classDirective('Odd', 0);
*
* @description
* The `ng-class-odd` and `ng-class-even` works exactly as
- * {@link angular.module.ng.$compileProvider.directive.ng-class ng-class}, except it works in conjunction with `ng-repeat` and
- * takes affect only on odd (even) rows.
+ * {@link angular.module.ng.$compileProvider.directive.ng-class ng-class}, except it works in
+ * conjunction with `ng-repeat` and takes affect only on odd (even) rows.
*
* This directive can be applied only within a scope of an
* {@link angular.module.ng.$compileProvider.directive.ng-repeat ng-repeat}.
*
* @element ANY
- * @param {expression} expression {@link guide/dev_guide.expressions Expression} to eval. The result
- * of the evaluation can be a string representing space delimited class names or an array.
+ * @param {expression} ng-class-even {@link guide/dev_guide.expressions Expression} to eval. The
+ * result of the evaluation can be a string representing space delimited class names or an array.
*
* @example
diff --git a/src/directive/ngController.js b/src/directive/ngController.js
index 7dd90f48..e5b8bffd 100644
--- a/src/directive/ngController.js
+++ b/src/directive/ngController.js
@@ -20,7 +20,7 @@
*
* @element ANY
* @scope
- * @param {expression} expression Name of a globally accessible constructor function or an
+ * @param {expression} ng-controller Name of a globally accessible constructor function or an
* {@link guide/dev_guide.expressions expression} that on the current scope evaluates to a
* constructor function.
*
diff --git a/src/directive/ngEventDirs.js b/src/directive/ngEventDirs.js
index 9563ee22..74028fee 100644
--- a/src/directive/ngEventDirs.js
+++ b/src/directive/ngEventDirs.js
@@ -9,7 +9,7 @@
* element is clicked.
*
* @element ANY
- * @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate upon
+ * @param {expression} ng-click {@link guide/dev_guide.expressions Expression} to evaluate upon
* click. (Event object is available as `$event`)
*
* @example
@@ -61,7 +61,7 @@ forEach(
* The ng-dblclick allows you to specify custom behavior on dblclick event.
*
* @element ANY
- * @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate upon
+ * @param {expression} ng-dblclick {@link guide/dev_guide.expressions Expression} to evaluate upon
* dblclick. (Event object is available as `$event`)
*
* @example
@@ -77,7 +77,7 @@ forEach(
* The ng-mousedown allows you to specify custom behavior on mousedown event.
*
* @element ANY
- * @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate upon
+ * @param {expression} ng-mousedown {@link guide/dev_guide.expressions Expression} to evaluate upon
* mousedown. (Event object is available as `$event`)
*
* @example
@@ -93,7 +93,7 @@ forEach(
* Specify custom behavior on mouseup event.
*
* @element ANY
- * @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate upon
+ * @param {expression} ng-mouseup {@link guide/dev_guide.expressions Expression} to evaluate upon
* mouseup. (Event object is available as `$event`)
*
* @example
@@ -108,7 +108,7 @@ forEach(
* Specify custom behavior on mouseover event.
*
* @element ANY
- * @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate upon
+ * @param {expression} ng-mouseover {@link guide/dev_guide.expressions Expression} to evaluate upon
* mouseover. (Event object is available as `$event`)
*
* @example
@@ -124,7 +124,7 @@ forEach(
* Specify custom behavior on mouseenter event.
*
* @element ANY
- * @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate upon
+ * @param {expression} ng-mouseenter {@link guide/dev_guide.expressions Expression} to evaluate upon
* mouseenter. (Event object is available as `$event`)
*
* @example
@@ -140,7 +140,7 @@ forEach(
* Specify custom behavior on mouseleave event.
*
* @element ANY
- * @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate upon
+ * @param {expression} ng-mouseleave {@link guide/dev_guide.expressions Expression} to evaluate upon
* mouseleave. (Event object is available as `$event`)
*
* @example
@@ -156,7 +156,7 @@ forEach(
* Specify custom behavior on mousemove event.
*
* @element ANY
- * @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate upon
+ * @param {expression} ng-mousemove {@link guide/dev_guide.expressions Expression} to evaluate upon
* mousemove. (Event object is available as `$event`)
*
* @example
@@ -175,7 +175,7 @@ forEach(
* server and reloading the current page).
*
* @element form
- * @param {expression} expression {@link guide/dev_guide.expressions Expression} to eval.
+ * @param {expression} ng-submit {@link guide/dev_guide.expressions Expression} to eval.
*
* @example
diff --git a/src/directive/ngInit.js b/src/directive/ngInit.js
index 644fec6a..cbd1b3ed 100644
--- a/src/directive/ngInit.js
+++ b/src/directive/ngInit.js
@@ -9,7 +9,7 @@
* before the template enters execution mode during bootstrap.
*
* @element ANY
- * @param {expression} expression {@link guide/dev_guide.expressions Expression} to eval.
+ * @param {expression} ng-init {@link guide/dev_guide.expressions Expression} to eval.
*
* @example
diff --git a/src/directive/ngRepeat.js b/src/directive/ngRepeat.js
index 7e7aef60..8e61ba28 100644
--- a/src/directive/ngRepeat.js
+++ b/src/directive/ngRepeat.js
@@ -22,7 +22,7 @@
* @element ANY
* @scope
* @priority 1000
- * @param {string} repeat_expression The expression indicating how to enumerate a collection. Two
+ * @param {repeat_expression} ng-repeat The expression indicating how to enumerate a collection. Two
* formats are currently supported:
*
* * `variable in expression` – where variable is the user defined loop variable and `expression`
diff --git a/src/directive/ngShowHide.js b/src/directive/ngShowHide.js
index ee3a17d9..40a8a68e 100644
--- a/src/directive/ngShowHide.js
+++ b/src/directive/ngShowHide.js
@@ -9,7 +9,7 @@
* conditionally.
*
* @element ANY
- * @param {expression} expression If the {@link guide/dev_guide.expressions expression} is truthy
+ * @param {expression} ng-show If the {@link guide/dev_guide.expressions expression} is truthy
* then the element is shown or hidden respectively.
*
* @example
@@ -49,7 +49,7 @@ var ngShowDirective = ngDirective(function(scope, element, attr){
* of the HTML conditionally.
*
* @element ANY
- * @param {expression} expression If the {@link guide/dev_guide.expressions expression} truthy then
+ * @param {expression} ng-hide If the {@link guide/dev_guide.expressions expression} truthy then
* the element is shown or hidden respectively.
*
* @example
diff --git a/src/directive/ngStyle.js b/src/directive/ngStyle.js
index 1dc1ee76..8a4e7458 100644
--- a/src/directive/ngStyle.js
+++ b/src/directive/ngStyle.js
@@ -8,7 +8,7 @@
* The ng-style allows you to set CSS style on an HTML element conditionally.
*
* @element ANY
- * @param {expression} expression {@link guide/dev_guide.expressions Expression} which evals to an
+ * @param {expression} ng-style {@link guide/dev_guide.expressions Expression} which evals to an
* object whose keys are CSS style names and values are corresponding values for those CSS
* keys.
*
--
cgit v1.2.3