Skip to content

Commit e0cc84a

Browse files
committed
docs(directives): set directive param name to directive name
so that we can render better usage examples in docs
1 parent 4a94bb9 commit e0cc84a

File tree

8 files changed

+26
-26
lines changed

8 files changed

+26
-26
lines changed

src/directive/ngBind.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
* `<span ng-bind="expression"></span>` when the template is compiled.
1515
*
1616
* @element ANY
17-
* @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate.
17+
* @param {expression} ng-bind {@link guide/dev_guide.expressions Expression} to evaluate.
1818
*
1919
* @example
2020
* 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) {
6060
* See {@link angular.module.ng.$sanitize $sanitize} docs for examples.
6161
*
6262
* @element ANY
63-
* @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate.
63+
* @param {expression} ng-bind-html-unsafe {@link guide/dev_guide.expressions Expression} to evaluate.
6464
*/
6565
var ngBindHtmlUnsafeDirective = ngDirective(function(scope, element, attr) {
6666
element.addClass('ng-binding').data('$binding', attr.ngBindHtmlUnsafe);
@@ -82,7 +82,7 @@ var ngBindHtmlUnsafeDirective = ngDirective(function(scope, element, attr) {
8282
* See {@link angular.module.ng.$sanitize $sanitize} docs for examples.
8383
*
8484
* @element ANY
85-
* @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate.
85+
* @param {expression} ng-bind-html {@link guide/dev_guide.expressions Expression} to evaluate.
8686
*/
8787
var ngBindHtmlDirective = ['$sanitize', function($sanitize) {
8888
return function(scope, element, attr) {
@@ -108,7 +108,7 @@ var ngBindHtmlDirective = ['$sanitize', function($sanitize) {
108108
* can not have SPAN elements such as TITLE, or OPTION to name a few.)
109109
*
110110
* @element ANY
111-
* @param {string} template of form
111+
* @param {string} ng-bind-template template of form
112112
* <tt>{{</tt> <tt>expression</tt> <tt>}}</tt> to eval.
113113
*
114114
* @example
@@ -191,7 +191,7 @@ var ngBindTemplateDirective = ['$interpolate', function($interpolate) {
191191
*
192192
*
193193
* @element ANY
194-
* @param {string} attribute_json one or more JSON key-value pairs representing
194+
* @param {string} ng-bind-attr one or more JSON key-value pairs representing
195195
* the attributes to replace with expressions. Each key matches an attribute
196196
* which needs to be replaced. Each value is a text template of
197197
* the attribute with the embedded

src/directive/ngClass.js

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ function classDirective(name, selector) {
3131
* new classes are added.
3232
*
3333
* @element ANY
34-
* @param {expression} expression {@link guide/dev_guide.expressions Expression} to eval. The result
34+
* @param {expression} ng-class {@link guide/dev_guide.expressions Expression} to eval. The result
3535
* of the evaluation can be a string representing space delimited class
3636
* names, an array, or a map of class names to boolean values.
3737
*
@@ -76,7 +76,7 @@ var ngClassDirective = classDirective('', true);
7676
* {@link angular.module.ng.$compileProvider.directive.ng-repeat ng-repeat}.
7777
*
7878
* @element ANY
79-
* @param {expression} expression {@link guide/dev_guide.expressions Expression} to eval. The result
79+
* @param {expression} ng-class-odd {@link guide/dev_guide.expressions Expression} to eval. The result
8080
* of the evaluation can be a string representing space delimited class names or an array.
8181
*
8282
* @example
@@ -109,15 +109,15 @@ var ngClassOddDirective = classDirective('Odd', 0);
109109
*
110110
* @description
111111
* The `ng-class-odd` and `ng-class-even` works exactly as
112-
* {@link angular.module.ng.$compileProvider.directive.ng-class ng-class}, except it works in conjunction with `ng-repeat` and
113-
* takes affect only on odd (even) rows.
112+
* {@link angular.module.ng.$compileProvider.directive.ng-class ng-class}, except it works in
113+
* conjunction with `ng-repeat` and takes affect only on odd (even) rows.
114114
*
115115
* This directive can be applied only within a scope of an
116116
* {@link angular.module.ng.$compileProvider.directive.ng-repeat ng-repeat}.
117117
*
118118
* @element ANY
119-
* @param {expression} expression {@link guide/dev_guide.expressions Expression} to eval. The result
120-
* of the evaluation can be a string representing space delimited class names or an array.
119+
* @param {expression} ng-class-even {@link guide/dev_guide.expressions Expression} to eval. The
120+
* result of the evaluation can be a string representing space delimited class names or an array.
121121
*
122122
* @example
123123
<doc:example>

src/directive/ngController.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
*
2121
* @element ANY
2222
* @scope
23-
* @param {expression} expression Name of a globally accessible constructor function or an
23+
* @param {expression} ng-controller Name of a globally accessible constructor function or an
2424
* {@link guide/dev_guide.expressions expression} that on the current scope evaluates to a
2525
* constructor function.
2626
*

src/directive/ngEventDirs.js

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* element is clicked.
1010
*
1111
* @element ANY
12-
* @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate upon
12+
* @param {expression} ng-click {@link guide/dev_guide.expressions Expression} to evaluate upon
1313
* click. (Event object is available as `$event`)
1414
*
1515
* @example
@@ -61,7 +61,7 @@ forEach(
6161
* The ng-dblclick allows you to specify custom behavior on dblclick event.
6262
*
6363
* @element ANY
64-
* @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate upon
64+
* @param {expression} ng-dblclick {@link guide/dev_guide.expressions Expression} to evaluate upon
6565
* dblclick. (Event object is available as `$event`)
6666
*
6767
* @example
@@ -77,7 +77,7 @@ forEach(
7777
* The ng-mousedown allows you to specify custom behavior on mousedown event.
7878
*
7979
* @element ANY
80-
* @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate upon
80+
* @param {expression} ng-mousedown {@link guide/dev_guide.expressions Expression} to evaluate upon
8181
* mousedown. (Event object is available as `$event`)
8282
*
8383
* @example
@@ -93,7 +93,7 @@ forEach(
9393
* Specify custom behavior on mouseup event.
9494
*
9595
* @element ANY
96-
* @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate upon
96+
* @param {expression} ng-mouseup {@link guide/dev_guide.expressions Expression} to evaluate upon
9797
* mouseup. (Event object is available as `$event`)
9898
*
9999
* @example
@@ -108,7 +108,7 @@ forEach(
108108
* Specify custom behavior on mouseover event.
109109
*
110110
* @element ANY
111-
* @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate upon
111+
* @param {expression} ng-mouseover {@link guide/dev_guide.expressions Expression} to evaluate upon
112112
* mouseover. (Event object is available as `$event`)
113113
*
114114
* @example
@@ -124,7 +124,7 @@ forEach(
124124
* Specify custom behavior on mouseenter event.
125125
*
126126
* @element ANY
127-
* @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate upon
127+
* @param {expression} ng-mouseenter {@link guide/dev_guide.expressions Expression} to evaluate upon
128128
* mouseenter. (Event object is available as `$event`)
129129
*
130130
* @example
@@ -140,7 +140,7 @@ forEach(
140140
* Specify custom behavior on mouseleave event.
141141
*
142142
* @element ANY
143-
* @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate upon
143+
* @param {expression} ng-mouseleave {@link guide/dev_guide.expressions Expression} to evaluate upon
144144
* mouseleave. (Event object is available as `$event`)
145145
*
146146
* @example
@@ -156,7 +156,7 @@ forEach(
156156
* Specify custom behavior on mousemove event.
157157
*
158158
* @element ANY
159-
* @param {expression} expression {@link guide/dev_guide.expressions Expression} to evaluate upon
159+
* @param {expression} ng-mousemove {@link guide/dev_guide.expressions Expression} to evaluate upon
160160
* mousemove. (Event object is available as `$event`)
161161
*
162162
* @example
@@ -175,7 +175,7 @@ forEach(
175175
* server and reloading the current page).
176176
*
177177
* @element form
178-
* @param {expression} expression {@link guide/dev_guide.expressions Expression} to eval.
178+
* @param {expression} ng-submit {@link guide/dev_guide.expressions Expression} to eval.
179179
*
180180
* @example
181181
<doc:example>

src/directive/ngInit.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* before the template enters execution mode during bootstrap.
1010
*
1111
* @element ANY
12-
* @param {expression} expression {@link guide/dev_guide.expressions Expression} to eval.
12+
* @param {expression} ng-init {@link guide/dev_guide.expressions Expression} to eval.
1313
*
1414
* @example
1515
<doc:example>

src/directive/ngRepeat.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
* @element ANY
2323
* @scope
2424
* @priority 1000
25-
* @param {string} repeat_expression The expression indicating how to enumerate a collection. Two
25+
* @param {repeat_expression} ng-repeat The expression indicating how to enumerate a collection. Two
2626
* formats are currently supported:
2727
*
2828
* * `variable in expression` – where variable is the user defined loop variable and `expression`

src/directive/ngShowHide.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
* conditionally.
1010
*
1111
* @element ANY
12-
* @param {expression} expression If the {@link guide/dev_guide.expressions expression} is truthy
12+
* @param {expression} ng-show If the {@link guide/dev_guide.expressions expression} is truthy
1313
* then the element is shown or hidden respectively.
1414
*
1515
* @example
@@ -49,7 +49,7 @@ var ngShowDirective = ngDirective(function(scope, element, attr){
4949
* of the HTML conditionally.
5050
*
5151
* @element ANY
52-
* @param {expression} expression If the {@link guide/dev_guide.expressions expression} truthy then
52+
* @param {expression} ng-hide If the {@link guide/dev_guide.expressions expression} truthy then
5353
* the element is shown or hidden respectively.
5454
*
5555
* @example

src/directive/ngStyle.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
* The ng-style allows you to set CSS style on an HTML element conditionally.
99
*
1010
* @element ANY
11-
* @param {expression} expression {@link guide/dev_guide.expressions Expression} which evals to an
11+
* @param {expression} ng-style {@link guide/dev_guide.expressions Expression} which evals to an
1212
* object whose keys are CSS style names and values are corresponding values for those CSS
1313
* keys.
1414
*

0 commit comments

Comments
 (0)