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

docs(misc core): @function and @kind function used inconsistently. Use @kind function. #7425

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions src/Angular.js
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@
* @ngdoc function
* @name angular.lowercase
* @module ng
* @function
* @kind function
*
* @description Converts the specified string to lowercase.
* @param {string} string String to be converted to lowercase.
Expand All @@ -119,7 +119,7 @@ var hasOwnProperty = Object.prototype.hasOwnProperty;
* @ngdoc function
* @name angular.uppercase
* @module ng
* @function
* @kind function
*
* @description Converts the specified string to uppercase.
* @param {string} string String to be converted to uppercase.
Expand Down Expand Up @@ -201,7 +201,7 @@ function isArrayLike(obj) {
* @ngdoc function
* @name angular.forEach
* @module ng
* @function
* @kind function
*
* @description
* Invokes the `iterator` function once for each item in `obj` collection, which can be either an
Expand Down Expand Up @@ -330,7 +330,7 @@ function setHashKey(obj, h) {
* @ngdoc function
* @name angular.extend
* @module ng
* @function
* @kind function
*
* @description
* Extends the destination object `dst` by copying all of the properties from the `src` object(s)
Expand Down Expand Up @@ -367,7 +367,7 @@ function inherit(parent, extra) {
* @ngdoc function
* @name angular.noop
* @module ng
* @function
* @kind function
*
* @description
* A function that performs no operations. This function can be useful when writing code in the
Expand All @@ -387,7 +387,7 @@ noop.$inject = [];
* @ngdoc function
* @name angular.identity
* @module ng
* @function
* @kind function
*
* @description
* A function that returns its first argument. This function is useful when writing code in the
Expand All @@ -409,7 +409,7 @@ function valueFn(value) {return function() {return value;};}
* @ngdoc function
* @name angular.isUndefined
* @module ng
* @function
* @kind function
*
* @description
* Determines if a reference is undefined.
Expand All @@ -424,7 +424,7 @@ function isUndefined(value){return typeof value === 'undefined';}
* @ngdoc function
* @name angular.isDefined
* @module ng
* @function
* @kind function
*
* @description
* Determines if a reference is defined.
Expand All @@ -439,7 +439,7 @@ function isDefined(value){return typeof value !== 'undefined';}
* @ngdoc function
* @name angular.isObject
* @module ng
* @function
* @kind function
*
* @description
* Determines if a reference is an `Object`. Unlike `typeof` in JavaScript, `null`s are not
Expand All @@ -455,7 +455,7 @@ function isObject(value){return value != null && typeof value === 'object';}
* @ngdoc function
* @name angular.isString
* @module ng
* @function
* @kind function
*
* @description
* Determines if a reference is a `String`.
Expand All @@ -470,7 +470,7 @@ function isString(value){return typeof value === 'string';}
* @ngdoc function
* @name angular.isNumber
* @module ng
* @function
* @kind function
*
* @description
* Determines if a reference is a `Number`.
Expand All @@ -485,7 +485,7 @@ function isNumber(value){return typeof value === 'number';}
* @ngdoc function
* @name angular.isDate
* @module ng
* @function
* @kind function
*
* @description
* Determines if a value is a date.
Expand All @@ -502,7 +502,7 @@ function isDate(value){
* @ngdoc function
* @name angular.isArray
* @module ng
* @function
* @kind function
*
* @description
* Determines if a reference is an `Array`.
Expand All @@ -519,7 +519,7 @@ function isArray(value) {
* @ngdoc function
* @name angular.isFunction
* @module ng
* @function
* @kind function
*
* @description
* Determines if a reference is a `Function`.
Expand Down Expand Up @@ -593,7 +593,7 @@ var trim = (function() {
* @ngdoc function
* @name angular.isElement
* @module ng
* @function
* @kind function
*
* @description
* Determines if a reference is a DOM element (or wrapped jQuery element).
Expand Down Expand Up @@ -704,7 +704,7 @@ function isLeafNode (node) {
* @ngdoc function
* @name angular.copy
* @module ng
* @function
* @kind function
*
* @description
* Creates a deep copy of `source`, which should be an object or an array.
Expand Down Expand Up @@ -820,7 +820,7 @@ function shallowCopy(src, dst) {
* @ngdoc function
* @name angular.equals
* @module ng
* @function
* @kind function
*
* @description
* Determines if two objects or two values are equivalent. Supports value types, regular
Expand Down Expand Up @@ -907,7 +907,7 @@ function sliceArgs(args, startIndex) {
* @ngdoc function
* @name angular.bind
* @module ng
* @function
* @kind function
*
* @description
* Returns a function which calls function `fn` bound to `self` (`self` becomes the `this` for
Expand Down Expand Up @@ -963,7 +963,7 @@ function toJsonReplacer(key, value) {
* @ngdoc function
* @name angular.toJson
* @module ng
* @function
* @kind function
*
* @description
* Serializes input into a JSON-formatted string. Properties with leading $ characters will be
Expand All @@ -983,7 +983,7 @@ function toJson(obj, pretty) {
* @ngdoc function
* @name angular.fromJson
* @module ng
* @function
* @kind function
*
* @description
* Deserializes a JSON string.
Expand Down
4 changes: 2 additions & 2 deletions src/auto/injector.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* @ngdoc function
* @module ng
* @name angular.injector
* @function
* @kind function
*
* @description
* Creates an injector function that can be used for retrieving services as well as for
Expand Down Expand Up @@ -120,7 +120,7 @@ function annotate(fn, strictDi, name) {
/**
* @ngdoc service
* @name $injector
* @function
* @kind function
*
* @description
*
Expand Down
2 changes: 1 addition & 1 deletion src/jqLite.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* @ngdoc function
* @name angular.element
* @module ng
* @function
* @kind function
*
* @description
* Wraps a raw DOM element or HTML string as a [jQuery](http://jquery.com) element.
Expand Down
12 changes: 6 additions & 6 deletions src/ng/animate.js
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ var $AnimateProvider = ['$provide', function($provide) {
*
* @ngdoc method
* @name $animate#enter
* @function
* @kind function
* @description Inserts the element into the DOM either after the `after` element or
* as the first child within the `parent` element. Once complete, the done() callback
* will be fired (if provided).
Expand All @@ -133,7 +133,7 @@ var $AnimateProvider = ['$provide', function($provide) {
*
* @ngdoc method
* @name $animate#leave
* @function
* @kind function
* @description Removes the element from the DOM. Once complete, the done() callback will be
* fired (if provided).
* @param {DOMElement} element the element which will be removed from the DOM
Expand All @@ -149,7 +149,7 @@ var $AnimateProvider = ['$provide', function($provide) {
*
* @ngdoc method
* @name $animate#move
* @function
* @kind function
* @description Moves the position of the provided element within the DOM to be placed
* either after the `after` element or inside of the `parent` element. Once complete, the
* done() callback will be fired (if provided).
Expand All @@ -173,7 +173,7 @@ var $AnimateProvider = ['$provide', function($provide) {
*
* @ngdoc method
* @name $animate#addClass
* @function
* @kind function
* @description Adds the provided className CSS class value to the provided element. Once
* complete, the done() callback will be fired (if provided).
* @param {DOMElement} element the element which will have the className value
Expand All @@ -196,7 +196,7 @@ var $AnimateProvider = ['$provide', function($provide) {
*
* @ngdoc method
* @name $animate#removeClass
* @function
* @kind function
* @description Removes the provided className CSS class value from the provided element.
* Once complete, the done() callback will be fired (if provided).
* @param {DOMElement} element the element which will have the className value
Expand All @@ -219,7 +219,7 @@ var $AnimateProvider = ['$provide', function($provide) {
*
* @ngdoc method
* @name $animate#setClass
* @function
* @kind function
* @description Adds and/or removes the given CSS classes to and from the element.
* Once complete, the done() callback will be fired (if provided).
* @param {DOMElement} element the element which will it's CSS classes changed
Expand Down
12 changes: 6 additions & 6 deletions src/ng/cacheFactory.js
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ function $CacheFactoryProvider() {
/**
* @ngdoc method
* @name $cacheFactory.Cache#put
* @function
* @kind function
*
* @description
* Inserts a named entry into the {@link $cacheFactory.Cache Cache} object to be
Expand Down Expand Up @@ -177,7 +177,7 @@ function $CacheFactoryProvider() {
/**
* @ngdoc method
* @name $cacheFactory.Cache#get
* @function
* @kind function
*
* @description
* Retrieves named data stored in the {@link $cacheFactory.Cache Cache} object.
Expand All @@ -201,7 +201,7 @@ function $CacheFactoryProvider() {
/**
* @ngdoc method
* @name $cacheFactory.Cache#remove
* @function
* @kind function
*
* @description
* Removes an entry from the {@link $cacheFactory.Cache Cache} object.
Expand Down Expand Up @@ -229,7 +229,7 @@ function $CacheFactoryProvider() {
/**
* @ngdoc method
* @name $cacheFactory.Cache#removeAll
* @function
* @kind function
*
* @description
* Clears the cache object of any entries.
Expand All @@ -245,7 +245,7 @@ function $CacheFactoryProvider() {
/**
* @ngdoc method
* @name $cacheFactory.Cache#destroy
* @function
* @kind function
*
* @description
* Destroys the {@link $cacheFactory.Cache Cache} object entirely,
Expand All @@ -262,7 +262,7 @@ function $CacheFactoryProvider() {
/**
* @ngdoc method
* @name $cacheFactory.Cache#info
* @function
* @kind function
*
* @description
* Retrieve information regarding a particular {@link $cacheFactory.Cache Cache}.
Expand Down
Loading