docs(misc core): use @kind function instead of @function

This commit is contained in:
Wes Alvaro
2014-05-22 07:55:10 +00:00
committed by Peter Bacon Darwin
parent 669e3aeaa8
commit b6388b3f1d
21 changed files with 88 additions and 88 deletions
+20 -20
View File
@@ -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.
@@ -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.
@@ -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
@@ -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)
@@ -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
@@ -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
@@ -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.
@@ -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.
@@ -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
@@ -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`.
@@ -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`.
@@ -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.
@@ -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`.
@@ -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`.
@@ -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).
@@ -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.
@@ -850,7 +850,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
@@ -937,7 +937,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
@@ -993,7 +993,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
@@ -1013,7 +1013,7 @@ function toJson(obj, pretty) {
* @ngdoc function
* @name angular.fromJson
* @module ng
* @function
* @kind function
*
* @description
* Deserializes a JSON string.
+2 -2
View File
@@ -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
@@ -101,7 +101,7 @@ function annotate(fn) {
/**
* @ngdoc service
* @name $injector
* @function
* @kind function
*
* @description
*
+1 -1
View File
@@ -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.
+6 -6
View File
@@ -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 within
* the `parent` element. Once complete, the done() callback will be fired (if provided).
* @param {DOMElement} element the element which will be inserted into the DOM
@@ -137,7 +137,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
@@ -153,7 +153,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).
@@ -177,7 +177,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
@@ -200,7 +200,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
@@ -223,7 +223,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 have its CSS classes changed
+6 -6
View File
@@ -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
@@ -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.
@@ -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.
@@ -229,7 +229,7 @@ function $CacheFactoryProvider() {
/**
* @ngdoc method
* @name $cacheFactory.Cache#removeAll
* @function
* @kind function
*
* @description
* Clears the cache object of any entries.
@@ -245,7 +245,7 @@ function $CacheFactoryProvider() {
/**
* @ngdoc method
* @name $cacheFactory.Cache#destroy
* @function
* @kind function
*
* @description
* Destroys the {@link $cacheFactory.Cache Cache} object entirely,
@@ -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}.
+10 -10
View File
@@ -21,7 +21,7 @@
/**
* @ngdoc service
* @name $compile
* @function
* @kind function
*
* @description
* Compiles an HTML string or DOM into a template and produces a template function, which
@@ -499,7 +499,7 @@ var $compileMinErr = minErr('$compile');
/**
* @ngdoc provider
* @name $compileProvider
* @function
* @kind function
*
* @description
*/
@@ -518,7 +518,7 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
/**
* @ngdoc method
* @name $compileProvider#directive
* @function
* @kind function
*
* @description
* Register a new directive with the compiler.
@@ -571,7 +571,7 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
/**
* @ngdoc method
* @name $compileProvider#aHrefSanitizationWhitelist
* @function
* @kind function
*
* @description
* Retrieves or overrides the default regular expression that is used for whitelisting of safe
@@ -601,7 +601,7 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
/**
* @ngdoc method
* @name $compileProvider#imgSrcSanitizationWhitelist
* @function
* @kind function
*
* @description
* Retrieves or overrides the default regular expression that is used for whitelisting of safe
@@ -645,7 +645,7 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
/**
* @ngdoc method
* @name $compile.directive.Attributes#$addClass
* @function
* @kind function
*
* @description
* Adds the CSS class value specified by the classVal parameter to the element. If animations
@@ -662,7 +662,7 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
/**
* @ngdoc method
* @name $compile.directive.Attributes#$removeClass
* @function
* @kind function
*
* @description
* Removes the CSS class value specified by the classVal parameter from the element. If
@@ -679,7 +679,7 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
/**
* @ngdoc method
* @name $compile.directive.Attributes#$updateClass
* @function
* @kind function
*
* @description
* Adds and removes the appropriate CSS class values to the element based on the difference
@@ -767,7 +767,7 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
/**
* @ngdoc method
* @name $compile.directive.Attributes#$observe
* @function
* @kind function
*
* @description
* Observes an interpolated attribute.
@@ -1980,7 +1980,7 @@ function directiveNormalize(name) {
/**
* @ngdoc method
* @name $compile.directive.Attributes#$set
* @function
* @kind function
*
* @description
* Set DOM element attribute value.
+1 -1
View File
@@ -63,7 +63,7 @@
/**
* @ngdoc service
* @name $filter
* @function
* @kind function
* @description
* Filters are used for formatting data displayed to the user.
*
+1 -1
View File
@@ -3,7 +3,7 @@
/**
* @ngdoc filter
* @name filter
* @function
* @kind function
*
* @description
* Selects a subset of items from `array` and returns it as a new array.
+6 -6
View File
@@ -3,7 +3,7 @@
/**
* @ngdoc filter
* @name currency
* @function
* @kind function
*
* @description
* Formats a number as a currency (ie $1,234.56). When no currency symbol is provided, default
@@ -60,7 +60,7 @@ function currencyFilter($locale) {
/**
* @ngdoc filter
* @name number
* @function
* @kind function
*
* @description
* Formats a number as text.
@@ -272,7 +272,7 @@ var DATE_FORMATS_SPLIT = /((?:[^yMdHhmsaZE']+)|(?:'(?:[^']|'')*')|(?:E+|y+|M+|d+
/**
* @ngdoc filter
* @name date
* @function
* @kind function
*
* @description
* Formats `date` to a string based on the requested `format`.
@@ -429,7 +429,7 @@ function dateFilter($locale) {
/**
* @ngdoc filter
* @name json
* @function
* @kind function
*
* @description
* Allows you to convert a JavaScript object into JSON string.
@@ -464,7 +464,7 @@ function jsonFilter() {
/**
* @ngdoc filter
* @name lowercase
* @function
* @kind function
* @description
* Converts string to lowercase.
* @see angular.lowercase
@@ -475,7 +475,7 @@ var lowercaseFilter = valueFn(lowercase);
/**
* @ngdoc filter
* @name uppercase
* @function
* @kind function
* @description
* Converts string to uppercase.
* @see angular.uppercase
+1 -1
View File
@@ -3,7 +3,7 @@
/**
* @ngdoc filter
* @name limitTo
* @function
* @kind function
*
* @description
* Creates a new array or string containing only a specified number of elements. The elements
+1 -1
View File
@@ -3,7 +3,7 @@
/**
* @ngdoc filter
* @name orderBy
* @function
* @kind function
*
* @description
* Orders a specified `array` by the `expression` predicate. It is ordered alphabetically
+2 -2
View File
@@ -5,7 +5,7 @@ var $interpolateMinErr = minErr('$interpolate');
/**
* @ngdoc provider
* @name $interpolateProvider
* @function
* @kind function
*
* @description
*
@@ -86,7 +86,7 @@ function $InterpolateProvider() {
/**
* @ngdoc service
* @name $interpolate
* @function
* @kind function
*
* @requires $parse
* @requires $sce
+1 -1
View File
@@ -1106,7 +1106,7 @@ function getterFn(path, options, fullExp) {
/**
* @ngdoc provider
* @name $parseProvider
* @function
* @kind function
*
* @description
* `$parseProvider` can be used for configuring the default behavior of the {@link ng.$parse $parse}
+4 -4
View File
@@ -191,7 +191,7 @@ function qFactory(nextTick, exceptionHandler) {
/**
* @ngdoc method
* @name $q#defer
* @function
* @kind function
*
* @description
* Creates a `Deferred` object which represents a task which will finish in the future.
@@ -348,7 +348,7 @@ function qFactory(nextTick, exceptionHandler) {
/**
* @ngdoc method
* @name $q#reject
* @function
* @kind function
*
* @description
* Creates a promise that is resolved as rejected with the specified `reason`. This api should be
@@ -408,7 +408,7 @@ function qFactory(nextTick, exceptionHandler) {
/**
* @ngdoc method
* @name $q#when
* @function
* @kind function
*
* @description
* Wraps an object that might be a value or a (3rd party) then-able promise into a $q promise.
@@ -480,7 +480,7 @@ function qFactory(nextTick, exceptionHandler) {
/**
* @ngdoc method
* @name $q#all
* @function
* @kind function
*
* @description
* Combines multiple promises into a single promise that is resolved when all of the input
+11 -11
View File
@@ -149,7 +149,7 @@ function $RootScopeProvider(){
/**
* @ngdoc method
* @name $rootScope.Scope#$new
* @function
* @kind function
*
* @description
* Creates a new child {@link ng.$rootScope.Scope scope}.
@@ -211,7 +211,7 @@ function $RootScopeProvider(){
/**
* @ngdoc method
* @name $rootScope.Scope#$watch
* @function
* @kind function
*
* @description
* Registers a `listener` callback to be executed whenever the `watchExpression` changes.
@@ -371,7 +371,7 @@ function $RootScopeProvider(){
/**
* @ngdoc method
* @name $rootScope.Scope#$watchCollection
* @function
* @kind function
*
* @description
* Shallow watches the properties of an object and fires whenever any of the properties change
@@ -547,7 +547,7 @@ function $RootScopeProvider(){
/**
* @ngdoc method
* @name $rootScope.Scope#$digest
* @function
* @kind function
*
* @description
* Processes all of the {@link ng.$rootScope.Scope#$watch watchers} of the current scope and
@@ -718,7 +718,7 @@ function $RootScopeProvider(){
/**
* @ngdoc method
* @name $rootScope.Scope#$destroy
* @function
* @kind function
*
* @description
* Removes the current scope (and all of its children) from the parent scope. Removal implies
@@ -779,7 +779,7 @@ function $RootScopeProvider(){
/**
* @ngdoc method
* @name $rootScope.Scope#$eval
* @function
* @kind function
*
* @description
* Executes the `expression` on the current scope and returns the result. Any exceptions in
@@ -811,7 +811,7 @@ function $RootScopeProvider(){
/**
* @ngdoc method
* @name $rootScope.Scope#$evalAsync
* @function
* @kind function
*
* @description
* Executes the expression on the current scope at a later point in time.
@@ -858,7 +858,7 @@ function $RootScopeProvider(){
/**
* @ngdoc method
* @name $rootScope.Scope#$apply
* @function
* @kind function
*
* @description
* `$apply()` is used to execute an expression in angular from outside of the angular
@@ -920,7 +920,7 @@ function $RootScopeProvider(){
/**
* @ngdoc method
* @name $rootScope.Scope#$on
* @function
* @kind function
*
* @description
* Listens on events of a given type. See {@link ng.$rootScope.Scope#$emit $emit} for
@@ -969,7 +969,7 @@ function $RootScopeProvider(){
/**
* @ngdoc method
* @name $rootScope.Scope#$emit
* @function
* @kind function
*
* @description
* Dispatches an event `name` upwards through the scope hierarchy notifying the
@@ -1037,7 +1037,7 @@ function $RootScopeProvider(){
/**
* @ngdoc method
* @name $rootScope.Scope#$broadcast
* @function
* @kind function
*
* @description
* Dispatches an event `name` downwards to all child scopes (and their children) notifying the
+6 -6
View File
@@ -65,7 +65,7 @@ function adjustMatchers(matchers) {
/**
* @ngdoc service
* @name $sceDelegate
* @function
* @kind function
*
* @description
*
@@ -137,7 +137,7 @@ function $SceDelegateProvider() {
/**
* @ngdoc method
* @name $sceDelegateProvider#resourceUrlWhitelist
* @function
* @kind function
*
* @param {Array=} whitelist When provided, replaces the resourceUrlWhitelist with the value
* provided. This must be an array or null. A snapshot of this array is used so further
@@ -166,7 +166,7 @@ function $SceDelegateProvider() {
/**
* @ngdoc method
* @name $sceDelegateProvider#resourceUrlBlacklist
* @function
* @kind function
*
* @param {Array=} blacklist When provided, replaces the resourceUrlBlacklist with the value
* provided. This must be an array or null. A snapshot of this array is used so further
@@ -393,7 +393,7 @@ function $SceDelegateProvider() {
/**
* @ngdoc service
* @name $sce
* @function
* @kind function
*
* @description
*
@@ -664,7 +664,7 @@ function $SceProvider() {
/**
* @ngdoc method
* @name $sceProvider#enabled
* @function
* @kind function
*
* @param {boolean=} value If provided, then enables/disables SCE.
* @return {boolean} true if SCE is enabled, false otherwise.
@@ -742,7 +742,7 @@ function $SceProvider() {
/**
* @ngdoc method
* @name $sce#isEnabled
* @function
* @kind function
*
* @return {Boolean} true if SCE is enabled, false otherwise. If you want to set the value, you
* have to do it at module config time on {@link ng.$sceProvider $sceProvider}.
+1 -1
View File
@@ -45,7 +45,7 @@ var originUrl = urlResolve(window.location.href, true);
* https://github.com/angular/angular.js/pull/2902
* http://james.padolsey.com/javascript/parsing-urls-with-the-dom/
*
* @function
* @kind function
* @param {string} url The URL to be parsed.
* @description Normalizes and parses a URL.
* @returns {object} Returns the normalized URL as a dictionary.
+5 -5
View File
@@ -501,7 +501,7 @@ angular.module('ngAnimate', ['ng'])
/**
* @ngdoc service
* @name $animate
* @function
* @kind function
*
* @description
* The `$animate` service provides animation detection support while performing DOM operations (enter, leave and move) as well as during addClass and removeClass operations.
@@ -521,7 +521,7 @@ angular.module('ngAnimate', ['ng'])
/**
* @ngdoc method
* @name $animate#enter
* @function
* @kind function
*
* @description
* Appends the element to the parentElement element that resides in the document and then runs the enter animation. Once
@@ -563,7 +563,7 @@ angular.module('ngAnimate', ['ng'])
/**
* @ngdoc method
* @name $animate#leave
* @function
* @kind function
*
* @description
* Runs the leave animation operation and, upon completion, removes the element from the DOM. Once
@@ -601,7 +601,7 @@ angular.module('ngAnimate', ['ng'])
/**
* @ngdoc method
* @name $animate#move
* @function
* @kind function
*
* @description
* Fires the move DOM operation. Just before the animation starts, the animate service will either append it into the parentElement container or
@@ -741,7 +741,7 @@ angular.module('ngAnimate', ['ng'])
/**
* @ngdoc method
* @name $animate#enabled
* @function
* @kind function
*
* @param {boolean=} value If provided then set the animation on or off.
* @param {DOMElement} element If provided then the element will be used to represent the enable/disable operation
+1 -1
View File
@@ -22,7 +22,7 @@ var ngRouteModule = angular.module('ngRoute', ['ng']).
/**
* @ngdoc provider
* @name $routeProvider
* @function
* @kind function
*
* @description
*
+1 -1
View File
@@ -5,7 +5,7 @@
/**
* @ngdoc filter
* @name linky
* @function
* @kind function
*
* @description
* Finds links in text input and turns them into html links. Supports http/https/ftp/mailto and
+1 -1
View File
@@ -37,7 +37,7 @@ var $sanitizeMinErr = angular.$$minErr('$sanitize');
/**
* @ngdoc service
* @name $sanitize
* @function
* @kind function
*
* @description
* The input is sanitized by parsing the html into tokens. All safe tokens (from a whitelist) are