Skip to content

Commit aa26856

Browse files
wesalvaropetebacondarwin
wesalvaro
authored and
petebacondarwin
committed
docs(misc core): Use @kind function instead of @function.
1 parent 5044238 commit aa26856

21 files changed

Lines changed: 89 additions & 89 deletions

‎src/Angular.js‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@
106106
* @ngdoc function
107107
* @name angular.lowercase
108108
* @module ng
109-
* @function
109+
* @kind function
110110
*
111111
* @description Converts the specified string to lowercase.
112112
* @param {string} string String to be converted to lowercase.
@@ -119,7 +119,7 @@ var hasOwnProperty = Object.prototype.hasOwnProperty;
119119
* @ngdoc function
120120
* @name angular.uppercase
121121
* @module ng
122-
* @function
122+
* @kind function
123123
*
124124
* @description Converts the specified string to uppercase.
125125
* @param {string} string String to be converted to uppercase.
@@ -201,7 +201,7 @@ function isArrayLike(obj) {
201201
* @ngdoc function
202202
* @name angular.forEach
203203
* @module ng
204-
* @function
204+
* @kind function
205205
*
206206
* @description
207207
* Invokes the `iterator` function once for each item in `obj` collection, which can be either an
@@ -330,7 +330,7 @@ function setHashKey(obj, h) {
330330
* @ngdoc function
331331
* @name angular.extend
332332
* @module ng
333-
* @function
333+
* @kind function
334334
*
335335
* @description
336336
* Extends the destination object `dst` by copying all of the properties from the `src` object(s)
@@ -367,7 +367,7 @@ function inherit(parent, extra) {
367367
* @ngdoc function
368368
* @name angular.noop
369369
* @module ng
370-
* @function
370+
* @kind function
371371
*
372372
* @description
373373
* A function that performs no operations. This function can be useful when writing code in the
@@ -387,7 +387,7 @@ noop.$inject = [];
387387
* @ngdoc function
388388
* @name angular.identity
389389
* @module ng
390-
* @function
390+
* @kind function
391391
*
392392
* @description
393393
* A function that returns its first argument. This function is useful when writing code in the
@@ -409,7 +409,7 @@ function valueFn(value) {return function() {return value;};}
409409
* @ngdoc function
410410
* @name angular.isUndefined
411411
* @module ng
412-
* @function
412+
* @kind function
413413
*
414414
* @description
415415
* Determines if a reference is undefined.
@@ -424,7 +424,7 @@ function isUndefined(value){return typeof value === 'undefined';}
424424
* @ngdoc function
425425
* @name angular.isDefined
426426
* @module ng
427-
* @function
427+
* @kind function
428428
*
429429
* @description
430430
* Determines if a reference is defined.
@@ -439,7 +439,7 @@ function isDefined(value){return typeof value !== 'undefined';}
439439
* @ngdoc function
440440
* @name angular.isObject
441441
* @module ng
442-
* @function
442+
* @kind function
443443
*
444444
* @description
445445
* Determines if a reference is an `Object`. Unlike `typeof` in JavaScript, `null`s are not
@@ -455,7 +455,7 @@ function isObject(value){return value != null && typeof value === 'object';}
455455
* @ngdoc function
456456
* @name angular.isString
457457
* @module ng
458-
* @function
458+
* @kind function
459459
*
460460
* @description
461461
* Determines if a reference is a `String`.
@@ -470,7 +470,7 @@ function isString(value){return typeof value === 'string';}
470470
* @ngdoc function
471471
* @name angular.isNumber
472472
* @module ng
473-
* @function
473+
* @kind function
474474
*
475475
* @description
476476
* Determines if a reference is a `Number`.
@@ -485,7 +485,7 @@ function isNumber(value){return typeof value === 'number';}
485485
* @ngdoc function
486486
* @name angular.isDate
487487
* @module ng
488-
* @function
488+
* @kind function
489489
*
490490
* @description
491491
* Determines if a value is a date.
@@ -502,7 +502,7 @@ function isDate(value) {
502502
* @ngdoc function
503503
* @name angular.isArray
504504
* @module ng
505-
* @function
505+
* @kind function
506506
*
507507
* @description
508508
* Determines if a reference is an `Array`.
@@ -519,7 +519,7 @@ function isArray(value) {
519519
* @ngdoc function
520520
* @name angular.isFunction
521521
* @module ng
522-
* @function
522+
* @kind function
523523
*
524524
* @description
525525
* Determines if a reference is a `Function`.
@@ -593,7 +593,7 @@ var trim = (function() {
593593
* @ngdoc function
594594
* @name angular.isElement
595595
* @module ng
596-
* @function
596+
* @kind function
597597
*
598598
* @description
599599
* Determines if a reference is a DOM element (or wrapped jQuery element).
@@ -704,7 +704,7 @@ function isLeafNode (node) {
704704
* @ngdoc function
705705
* @name angular.copy
706706
* @module ng
707-
* @function
707+
* @kind function
708708
*
709709
* @description
710710
* Creates a deep copy of `source`, which should be an object or an array.
@@ -850,7 +850,7 @@ function shallowCopy(src, dst) {
850850
* @ngdoc function
851851
* @name angular.equals
852852
* @module ng
853-
* @function
853+
* @kind function
854854
*
855855
* @description
856856
* Determines if two objects or two values are equivalent. Supports value types, regular
@@ -937,7 +937,7 @@ function sliceArgs(args, startIndex) {
937937
* @ngdoc function
938938
* @name angular.bind
939939
* @module ng
940-
* @function
940+
* @kind function
941941
*
942942
* @description
943943
* Returns a function which calls function `fn` bound to `self` (`self` becomes the `this` for
@@ -993,7 +993,7 @@ function toJsonReplacer(key, value) {
993993
* @ngdoc function
994994
* @name angular.toJson
995995
* @module ng
996-
* @function
996+
* @kind function
997997
*
998998
* @description
999999
* Serializes input into a JSON-formatted string. Properties with leading $$ characters will be
@@ -1013,7 +1013,7 @@ function toJson(obj, pretty) {
10131013
* @ngdoc function
10141014
* @name angular.fromJson
10151015
* @module ng
1016-
* @function
1016+
* @kind function
10171017
*
10181018
* @description
10191019
* Deserializes a JSON string.

‎src/auto/injector.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
* @ngdoc function
55
* @module ng
66
* @name angular.injector
7-
* @function
7+
* @kind function
88
*
99
* @description
1010
* Creates an injector function that can be used for retrieving services as well as for
@@ -120,7 +120,7 @@ function annotate(fn, strictDi, name) {
120120
/**
121121
* @ngdoc service
122122
* @name $injector
123-
* @function
123+
* @kind function
124124
*
125125
* @description
126126
*

‎src/jqLite.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* @ngdoc function
1717
* @name angular.element
1818
* @module ng
19-
* @function
19+
* @kind function
2020
*
2121
* @description
2222
* Wraps a raw DOM element or HTML string as a [jQuery](http://jquery.com) element.

‎src/ng/animate.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ var $AnimateProvider = ['$provide', function($provide) {
110110
*
111111
* @ngdoc method
112112
* @name $animate#enter
113-
* @function
113+
* @kind function
114114
* @description Inserts the element into the DOM either after the `after` element or
115115
* as the first child within the `parent` element. Once complete, the done() callback
116116
* will be fired (if provided).
@@ -133,7 +133,7 @@ var $AnimateProvider = ['$provide', function($provide) {
133133
*
134134
* @ngdoc method
135135
* @name $animate#leave
136-
* @function
136+
* @kind function
137137
* @description Removes the element from the DOM. Once complete, the done() callback will be
138138
* fired (if provided).
139139
* @param {DOMElement} element the element which will be removed from the DOM
@@ -149,7 +149,7 @@ var $AnimateProvider = ['$provide', function($provide) {
149149
*
150150
* @ngdoc method
151151
* @name $animate#move
152-
* @function
152+
* @kind function
153153
* @description Moves the position of the provided element within the DOM to be placed
154154
* either after the `after` element or inside of the `parent` element. Once complete, the
155155
* done() callback will be fired (if provided).
@@ -173,7 +173,7 @@ var $AnimateProvider = ['$provide', function($provide) {
173173
*
174174
* @ngdoc method
175175
* @name $animate#addClass
176-
* @function
176+
* @kind function
177177
* @description Adds the provided className CSS class value to the provided element. Once
178178
* complete, the done() callback will be fired (if provided).
179179
* @param {DOMElement} element the element which will have the className value
@@ -196,7 +196,7 @@ var $AnimateProvider = ['$provide', function($provide) {
196196
*
197197
* @ngdoc method
198198
* @name $animate#removeClass
199-
* @function
199+
* @kind function
200200
* @description Removes the provided className CSS class value from the provided element.
201201
* Once complete, the done() callback will be fired (if provided).
202202
* @param {DOMElement} element the element which will have the className value
@@ -219,7 +219,7 @@ var $AnimateProvider = ['$provide', function($provide) {
219219
*
220220
* @ngdoc method
221221
* @name $animate#setClass
222-
* @function
222+
* @kind function
223223
* @description Adds and/or removes the given CSS classes to and from the element.
224224
* Once complete, the done() callback will be fired (if provided).
225225
* @param {DOMElement} element the element which will have its CSS classes changed

‎src/ng/cacheFactory.js‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ function $CacheFactoryProvider() {
141141
/**
142142
* @ngdoc method
143143
* @name $cacheFactory.Cache#put
144-
* @function
144+
* @kind function
145145
*
146146
* @description
147147
* Inserts a named entry into the {@link $cacheFactory.Cache Cache} object to be
@@ -177,7 +177,7 @@ function $CacheFactoryProvider() {
177177
/**
178178
* @ngdoc method
179179
* @name $cacheFactory.Cache#get
180-
* @function
180+
* @kind function
181181
*
182182
* @description
183183
* Retrieves named data stored in the {@link $cacheFactory.Cache Cache} object.
@@ -201,7 +201,7 @@ function $CacheFactoryProvider() {
201201
/**
202202
* @ngdoc method
203203
* @name $cacheFactory.Cache#remove
204-
* @function
204+
* @kind function
205205
*
206206
* @description
207207
* Removes an entry from the {@link $cacheFactory.Cache Cache} object.
@@ -229,7 +229,7 @@ function $CacheFactoryProvider() {
229229
/**
230230
* @ngdoc method
231231
* @name $cacheFactory.Cache#removeAll
232-
* @function
232+
* @kind function
233233
*
234234
* @description
235235
* Clears the cache object of any entries.
@@ -245,7 +245,7 @@ function $CacheFactoryProvider() {
245245
/**
246246
* @ngdoc method
247247
* @name $cacheFactory.Cache#destroy
248-
* @function
248+
* @kind function
249249
*
250250
* @description
251251
* Destroys the {@link $cacheFactory.Cache Cache} object entirely,
@@ -262,7 +262,7 @@ function $CacheFactoryProvider() {
262262
/**
263263
* @ngdoc method
264264
* @name $cacheFactory.Cache#info
265-
* @function
265+
* @kind function
266266
*
267267
* @description
268268
* Retrieve information regarding a particular {@link $cacheFactory.Cache Cache}.

0 commit comments

Comments
 (0)