Skip to content
This repository was archived by the owner on Apr 12, 2024. It is now read-only.

Commit 10108c0

Browse files
committed
docs(jsdoc): remove "@kind function" from everything but services
1 parent c6bde52 commit 10108c0

19 files changed

+0
-84
lines changed

src/Angular.js

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,6 @@ var VALIDITY_STATE_PROPERTY = 'validity';
112112
* @ngdoc function
113113
* @name angular.lowercase
114114
* @module ng
115-
* @kind function
116115
*
117116
* @description Converts the specified string to lowercase.
118117
* @param {string} string String to be converted to lowercase.
@@ -125,7 +124,6 @@ var hasOwnProperty = Object.prototype.hasOwnProperty;
125124
* @ngdoc function
126125
* @name angular.uppercase
127126
* @module ng
128-
* @kind function
129127
*
130128
* @description Converts the specified string to uppercase.
131129
* @param {string} string String to be converted to uppercase.
@@ -206,7 +204,6 @@ function isArrayLike(obj) {
206204
* @ngdoc function
207205
* @name angular.forEach
208206
* @module ng
209-
* @kind function
210207
*
211208
* @description
212209
* Invokes the `iterator` function once for each item in `obj` collection, which can be either an
@@ -324,7 +321,6 @@ function setHashKey(obj, h) {
324321
* @ngdoc function
325322
* @name angular.extend
326323
* @module ng
327-
* @kind function
328324
*
329325
* @description
330326
* Extends the destination object `dst` by copying all of the properties from the `src` object(s)
@@ -361,7 +357,6 @@ function inherit(parent, extra) {
361357
* @ngdoc function
362358
* @name angular.noop
363359
* @module ng
364-
* @kind function
365360
*
366361
* @description
367362
* A function that performs no operations. This function can be useful when writing code in the
@@ -381,7 +376,6 @@ noop.$inject = [];
381376
* @ngdoc function
382377
* @name angular.identity
383378
* @module ng
384-
* @kind function
385379
*
386380
* @description
387381
* A function that returns its first argument. This function is useful when writing code in the
@@ -403,7 +397,6 @@ function valueFn(value) {return function() {return value;};}
403397
* @ngdoc function
404398
* @name angular.isUndefined
405399
* @module ng
406-
* @kind function
407400
*
408401
* @description
409402
* Determines if a reference is undefined.
@@ -418,7 +411,6 @@ function isUndefined(value){return typeof value === 'undefined';}
418411
* @ngdoc function
419412
* @name angular.isDefined
420413
* @module ng
421-
* @kind function
422414
*
423415
* @description
424416
* Determines if a reference is defined.
@@ -433,7 +425,6 @@ function isDefined(value){return typeof value !== 'undefined';}
433425
* @ngdoc function
434426
* @name angular.isObject
435427
* @module ng
436-
* @kind function
437428
*
438429
* @description
439430
* Determines if a reference is an `Object`. Unlike `typeof` in JavaScript, `null`s are not
@@ -452,7 +443,6 @@ function isObject(value){
452443
* @ngdoc function
453444
* @name angular.isString
454445
* @module ng
455-
* @kind function
456446
*
457447
* @description
458448
* Determines if a reference is a `String`.
@@ -467,7 +457,6 @@ function isString(value){return typeof value === 'string';}
467457
* @ngdoc function
468458
* @name angular.isNumber
469459
* @module ng
470-
* @kind function
471460
*
472461
* @description
473462
* Determines if a reference is a `Number`.
@@ -482,7 +471,6 @@ function isNumber(value){return typeof value === 'number';}
482471
* @ngdoc function
483472
* @name angular.isDate
484473
* @module ng
485-
* @kind function
486474
*
487475
* @description
488476
* Determines if a value is a date.
@@ -499,7 +487,6 @@ function isDate(value) {
499487
* @ngdoc function
500488
* @name angular.isArray
501489
* @module ng
502-
* @kind function
503490
*
504491
* @description
505492
* Determines if a reference is an `Array`.
@@ -513,7 +500,6 @@ var isArray = Array.isArray;
513500
* @ngdoc function
514501
* @name angular.isFunction
515502
* @module ng
516-
* @kind function
517503
*
518504
* @description
519505
* Determines if a reference is a `Function`.
@@ -582,7 +568,6 @@ var trim = function(value) {
582568
* @ngdoc function
583569
* @name angular.isElement
584570
* @module ng
585-
* @kind function
586571
*
587572
* @description
588573
* Determines if a reference is a DOM element (or wrapped jQuery element).
@@ -685,7 +670,6 @@ function isLeafNode (node) {
685670
* @ngdoc function
686671
* @name angular.copy
687672
* @module ng
688-
* @kind function
689673
*
690674
* @description
691675
* Creates a deep copy of `source`, which should be an object or an array.
@@ -842,7 +826,6 @@ function shallowCopy(src, dst) {
842826
* @ngdoc function
843827
* @name angular.equals
844828
* @module ng
845-
* @kind function
846829
*
847830
* @description
848831
* Determines if two objects or two values are equivalent. Supports value types, regular
@@ -943,7 +926,6 @@ function sliceArgs(args, startIndex) {
943926
* @ngdoc function
944927
* @name angular.bind
945928
* @module ng
946-
* @kind function
947929
*
948930
* @description
949931
* Returns a function which calls function `fn` bound to `self` (`self` becomes the `this` for
@@ -999,7 +981,6 @@ function toJsonReplacer(key, value) {
999981
* @ngdoc function
1000982
* @name angular.toJson
1001983
* @module ng
1002-
* @kind function
1003984
*
1004985
* @description
1005986
* Serializes input into a JSON-formatted string. Properties with leading $$ characters will be
@@ -1019,7 +1000,6 @@ function toJson(obj, pretty) {
10191000
* @ngdoc function
10201001
* @name angular.fromJson
10211002
* @module ng
1022-
* @kind function
10231003
*
10241004
* @description
10251005
* Deserializes a JSON string.

src/auto/injector.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
* @ngdoc function
55
* @module ng
66
* @name angular.injector
7-
* @kind function
87
*
98
* @description
109
* Creates an injector function that can be used for retrieving services as well as for

src/jqLite.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
* @ngdoc function
1616
* @name angular.element
1717
* @module ng
18-
* @kind function
1918
*
2019
* @description
2120
* Wraps a raw DOM element or HTML string as a [jQuery](http://jquery.com) element.

src/ng/animate.js

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,6 @@ var $AnimateProvider = ['$provide', function($provide) {
120120
*
121121
* @ngdoc method
122122
* @name $animate#enter
123-
* @kind function
124123
* @description Inserts the element into the DOM either after the `after` element or
125124
* as the first child within the `parent` element. When the function is called a promise
126125
* is returned that will be resolved at a later time.
@@ -141,7 +140,6 @@ var $AnimateProvider = ['$provide', function($provide) {
141140
*
142141
* @ngdoc method
143142
* @name $animate#leave
144-
* @kind function
145143
* @description Removes the element from the DOM. When the function is called a promise
146144
* is returned that will be resolved at a later time.
147145
* @param {DOMElement} element the element which will be removed from the DOM
@@ -156,7 +154,6 @@ var $AnimateProvider = ['$provide', function($provide) {
156154
*
157155
* @ngdoc method
158156
* @name $animate#move
159-
* @kind function
160157
* @description Moves the position of the provided element within the DOM to be placed
161158
* either after the `after` element or inside of the `parent` element. When the function
162159
* is called a promise is returned that will be resolved at a later time.
@@ -179,7 +176,6 @@ var $AnimateProvider = ['$provide', function($provide) {
179176
*
180177
* @ngdoc method
181178
* @name $animate#addClass
182-
* @kind function
183179
* @description Adds the provided className CSS class value to the provided element.
184180
* When the function is called a promise is returned that will be resolved at a later time.
185181
* @param {DOMElement} element the element which will have the className value
@@ -201,7 +197,6 @@ var $AnimateProvider = ['$provide', function($provide) {
201197
*
202198
* @ngdoc method
203199
* @name $animate#removeClass
204-
* @kind function
205200
* @description Removes the provided className CSS class value from the provided element.
206201
* When the function is called a promise is returned that will be resolved at a later time.
207202
* @param {DOMElement} element the element which will have the className value
@@ -223,7 +218,6 @@ var $AnimateProvider = ['$provide', function($provide) {
223218
*
224219
* @ngdoc method
225220
* @name $animate#setClass
226-
* @kind function
227221
* @description Adds and/or removes the given CSS classes to and from the element.
228222
* When the function is called a promise is returned that will be resolved at a later time.
229223
* @param {DOMElement} element the element which will have its CSS classes changed

src/ng/cacheFactory.js

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,6 @@ function $CacheFactoryProvider() {
143143
/**
144144
* @ngdoc method
145145
* @name $cacheFactory.Cache#put
146-
* @kind function
147146
*
148147
* @description
149148
* Inserts a named entry into the {@link $cacheFactory.Cache Cache} object to be
@@ -179,7 +178,6 @@ function $CacheFactoryProvider() {
179178
/**
180179
* @ngdoc method
181180
* @name $cacheFactory.Cache#get
182-
* @kind function
183181
*
184182
* @description
185183
* Retrieves named data stored in the {@link $cacheFactory.Cache Cache} object.
@@ -203,7 +201,6 @@ function $CacheFactoryProvider() {
203201
/**
204202
* @ngdoc method
205203
* @name $cacheFactory.Cache#remove
206-
* @kind function
207204
*
208205
* @description
209206
* Removes an entry from the {@link $cacheFactory.Cache Cache} object.
@@ -231,7 +228,6 @@ function $CacheFactoryProvider() {
231228
/**
232229
* @ngdoc method
233230
* @name $cacheFactory.Cache#removeAll
234-
* @kind function
235231
*
236232
* @description
237233
* Clears the cache object of any entries.
@@ -247,7 +243,6 @@ function $CacheFactoryProvider() {
247243
/**
248244
* @ngdoc method
249245
* @name $cacheFactory.Cache#destroy
250-
* @kind function
251246
*
252247
* @description
253248
* Destroys the {@link $cacheFactory.Cache Cache} object entirely,
@@ -264,7 +259,6 @@ function $CacheFactoryProvider() {
264259
/**
265260
* @ngdoc method
266261
* @name $cacheFactory.Cache#info
267-
* @kind function
268262
*
269263
* @description
270264
* Retrieve information regarding a particular {@link $cacheFactory.Cache Cache}.

src/ng/compile.js

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -539,7 +539,6 @@ var $compileMinErr = minErr('$compile');
539539
/**
540540
* @ngdoc provider
541541
* @name $compileProvider
542-
* @kind function
543542
*
544543
* @description
545544
*/
@@ -559,7 +558,6 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
559558
/**
560559
* @ngdoc method
561560
* @name $compileProvider#directive
562-
* @kind function
563561
*
564562
* @description
565563
* Register a new directive with the compiler.
@@ -612,7 +610,6 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
612610
/**
613611
* @ngdoc method
614612
* @name $compileProvider#aHrefSanitizationWhitelist
615-
* @kind function
616613
*
617614
* @description
618615
* Retrieves or overrides the default regular expression that is used for whitelisting of safe
@@ -642,7 +639,6 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
642639
/**
643640
* @ngdoc method
644641
* @name $compileProvider#imgSrcSanitizationWhitelist
645-
* @kind function
646642
*
647643
* @description
648644
* Retrieves or overrides the default regular expression that is used for whitelisting of safe
@@ -676,7 +672,6 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
676672
* current debugInfoEnabled state
677673
* @returns {*} current value if used as getter or itself (chaining) if used as setter
678674
*
679-
* @kind function
680675
*
681676
* @description
682677
* Call this method to enable/disable various debug runtime information in the compiler such as adding
@@ -728,7 +723,6 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
728723
/**
729724
* @ngdoc method
730725
* @name $compile.directive.Attributes#$addClass
731-
* @kind function
732726
*
733727
* @description
734728
* Adds the CSS class value specified by the classVal parameter to the element. If animations
@@ -745,7 +739,6 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
745739
/**
746740
* @ngdoc method
747741
* @name $compile.directive.Attributes#$removeClass
748-
* @kind function
749742
*
750743
* @description
751744
* Removes the CSS class value specified by the classVal parameter from the element. If
@@ -762,7 +755,6 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
762755
/**
763756
* @ngdoc method
764757
* @name $compile.directive.Attributes#$updateClass
765-
* @kind function
766758
*
767759
* @description
768760
* Adds and removes the appropriate CSS class values to the element based on the difference
@@ -855,7 +847,6 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
855847
/**
856848
* @ngdoc method
857849
* @name $compile.directive.Attributes#$observe
858-
* @kind function
859850
*
860851
* @description
861852
* Observes an interpolated attribute.
@@ -2251,7 +2242,6 @@ function directiveNormalize(name) {
22512242
/**
22522243
* @ngdoc method
22532244
* @name $compile.directive.Attributes#$set
2254-
* @kind function
22552245
*
22562246
* @description
22572247
* Set DOM element attribute value.

src/ng/filter/filter.js

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
/**
44
* @ngdoc filter
55
* @name filter
6-
* @kind function
76
*
87
* @description
98
* Selects a subset of items from `array` and returns it as a new array.

0 commit comments

Comments
 (0)