docs(directives): set directive param name to directive name

so that we can render better usage examples in docs
This commit is contained in:
Igor Minar 2012-03-09 15:18:57 -08:00
parent 4a94bb9b34
commit e0cc84ad7b
8 changed files with 26 additions and 26 deletions

View file

@ -14,7 +14,7 @@
* `<span ng-bind="expression"></span>` when the template is compiled. * `<span ng-bind="expression"></span>` when the template is compiled.
* *
* @element ANY * @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 * @example
* Enter a name in the Live Preview text box; the greeting below the text box changes instantly. * 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. * See {@link angular.module.ng.$sanitize $sanitize} docs for examples.
* *
* @element ANY * @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) { var ngBindHtmlUnsafeDirective = ngDirective(function(scope, element, attr) {
element.addClass('ng-binding').data('$binding', attr.ngBindHtmlUnsafe); 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. * See {@link angular.module.ng.$sanitize $sanitize} docs for examples.
* *
* @element ANY * @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) { var ngBindHtmlDirective = ['$sanitize', function($sanitize) {
return function(scope, element, attr) { 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.) * can not have SPAN elements such as TITLE, or OPTION to name a few.)
* *
* @element ANY * @element ANY
* @param {string} template of form * @param {string} ng-bind-template template of form
* <tt>{{</tt> <tt>expression</tt> <tt>}}</tt> to eval. * <tt>{{</tt> <tt>expression</tt> <tt>}}</tt> to eval.
* *
* @example * @example
@ -191,7 +191,7 @@ var ngBindTemplateDirective = ['$interpolate', function($interpolate) {
* *
* *
* @element ANY * @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 * the attributes to replace with expressions. Each key matches an attribute
* which needs to be replaced. Each value is a text template of * which needs to be replaced. Each value is a text template of
* the attribute with the embedded * the attribute with the embedded

View file

@ -31,7 +31,7 @@ function classDirective(name, selector) {
* new classes are added. * new classes are added.
* *
* @element ANY * @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 * of the evaluation can be a string representing space delimited class
* names, an array, or a map of class names to boolean values. * 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}. * {@link angular.module.ng.$compileProvider.directive.ng-repeat ng-repeat}.
* *
* @element ANY * @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. * of the evaluation can be a string representing space delimited class names or an array.
* *
* @example * @example
@ -109,15 +109,15 @@ var ngClassOddDirective = classDirective('Odd', 0);
* *
* @description * @description
* The `ng-class-odd` and `ng-class-even` works exactly as * 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 * {@link angular.module.ng.$compileProvider.directive.ng-class ng-class}, except it works in
* takes affect only on odd (even) rows. * conjunction with `ng-repeat` and takes affect only on odd (even) rows.
* *
* This directive can be applied only within a scope of an * This directive can be applied only within a scope of an
* {@link angular.module.ng.$compileProvider.directive.ng-repeat ng-repeat}. * {@link angular.module.ng.$compileProvider.directive.ng-repeat ng-repeat}.
* *
* @element ANY * @element ANY
* @param {expression} expression {@link guide/dev_guide.expressions Expression} to eval. The result * @param {expression} ng-class-even {@link guide/dev_guide.expressions Expression} to eval. The
* of the evaluation can be a string representing space delimited class names or an array. * result of the evaluation can be a string representing space delimited class names or an array.
* *
* @example * @example
<doc:example> <doc:example>

View file

@ -20,7 +20,7 @@
* *
* @element ANY * @element ANY
* @scope * @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 * {@link guide/dev_guide.expressions expression} that on the current scope evaluates to a
* constructor function. * constructor function.
* *

View file

@ -9,7 +9,7 @@
* element is clicked. * element is clicked.
* *
* @element ANY * @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`) * click. (Event object is available as `$event`)
* *
* @example * @example
@ -61,7 +61,7 @@ forEach(
* The ng-dblclick allows you to specify custom behavior on dblclick event. * The ng-dblclick allows you to specify custom behavior on dblclick event.
* *
* @element ANY * @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`) * dblclick. (Event object is available as `$event`)
* *
* @example * @example
@ -77,7 +77,7 @@ forEach(
* The ng-mousedown allows you to specify custom behavior on mousedown event. * The ng-mousedown allows you to specify custom behavior on mousedown event.
* *
* @element ANY * @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`) * mousedown. (Event object is available as `$event`)
* *
* @example * @example
@ -93,7 +93,7 @@ forEach(
* Specify custom behavior on mouseup event. * Specify custom behavior on mouseup event.
* *
* @element ANY * @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`) * mouseup. (Event object is available as `$event`)
* *
* @example * @example
@ -108,7 +108,7 @@ forEach(
* Specify custom behavior on mouseover event. * Specify custom behavior on mouseover event.
* *
* @element ANY * @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`) * mouseover. (Event object is available as `$event`)
* *
* @example * @example
@ -124,7 +124,7 @@ forEach(
* Specify custom behavior on mouseenter event. * Specify custom behavior on mouseenter event.
* *
* @element ANY * @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`) * mouseenter. (Event object is available as `$event`)
* *
* @example * @example
@ -140,7 +140,7 @@ forEach(
* Specify custom behavior on mouseleave event. * Specify custom behavior on mouseleave event.
* *
* @element ANY * @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`) * mouseleave. (Event object is available as `$event`)
* *
* @example * @example
@ -156,7 +156,7 @@ forEach(
* Specify custom behavior on mousemove event. * Specify custom behavior on mousemove event.
* *
* @element ANY * @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`) * mousemove. (Event object is available as `$event`)
* *
* @example * @example
@ -175,7 +175,7 @@ forEach(
* server and reloading the current page). * server and reloading the current page).
* *
* @element form * @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 * @example
<doc:example> <doc:example>

View file

@ -9,7 +9,7 @@
* before the template enters execution mode during bootstrap. * before the template enters execution mode during bootstrap.
* *
* @element ANY * @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 * @example
<doc:example> <doc:example>

View file

@ -22,7 +22,7 @@
* @element ANY * @element ANY
* @scope * @scope
* @priority 1000 * @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: * formats are currently supported:
* *
* * `variable in expression` where variable is the user defined loop variable and `expression` * * `variable in expression` where variable is the user defined loop variable and `expression`

View file

@ -9,7 +9,7 @@
* conditionally. * conditionally.
* *
* @element ANY * @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. * then the element is shown or hidden respectively.
* *
* @example * @example
@ -49,7 +49,7 @@ var ngShowDirective = ngDirective(function(scope, element, attr){
* of the HTML conditionally. * of the HTML conditionally.
* *
* @element ANY * @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. * the element is shown or hidden respectively.
* *
* @example * @example

View file

@ -8,7 +8,7 @@
* The ng-style allows you to set CSS style on an HTML element conditionally. * The ng-style allows you to set CSS style on an HTML element conditionally.
* *
* @element ANY * @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 * object whose keys are CSS style names and values are corresponding values for those CSS
* keys. * keys.
* *