docs(browser): moved and migrate browser removed unneeded files.

This commit is contained in:
Misko Hevery 2011-11-10 12:12:02 -08:00
parent a8aa193c6b
commit 1cc6bee4ce
3 changed files with 23 additions and 51 deletions

2
angularFiles.js vendored
View file

@ -4,10 +4,10 @@ angularFiles = {
'src/JSON.js',
'src/Injector.js',
'src/Resource.js',
'src/Browser.js',
'src/sanitizer.js',
'src/jqLite.js',
'src/apis.js',
'src/service/browser.js',
'src/service/compiler.js',
'src/service/cookieStore.js',
'src/service/cookies.js',

View file

@ -1,25 +0,0 @@
@ngdoc overview
@name angular.service
@description
The services API provides objects for carrying out common web app tasks. Service objects are
managed by angular's {@link guide/dev_guide.di dependency injection system}.
* {@link angular.service.$browser $browser } - Provides an instance of a browser object
* {@link angular.service.$cookieStore $cookieStore } - Provides key / value storage backed by
session cookies
* {@link angular.service.$cookies $cookies } - Provides read / write access to browser cookies
* {@link angular.service.$defer $defer } - Defers function execution and try / catch block
* {@link angular.service.$document $document } - Provides reference to `window.document` element
* {@link angular.service.$exceptionHandler $exceptionHandler } - Receives uncaught angular
exceptions
* {@link angular.service.$location $location } - Parses the browser location URL
* {@link angular.service.$log $log } - Provides logging service
* {@link angular.service.$resource $resource } - Creates objects for interacting with RESTful
server-side data sources
* {@link angular.service.$route $route } - Provides deep-linking services
* {@link angular.service.$window $window } - References the browsers `window` object
* {@link angular.service.$xhr $xhr} - Generates an XHR request.
For information on how angular services work and how to write your own services, see {@link
guide/dev_guide.services Angular Services} in the angular Developer Guide.

View file

@ -12,13 +12,10 @@ var XHR = window.XMLHttpRequest || function() {
/**
* @ngdoc service
* @name angular.service.$browser
* @ngdoc object
* @name angular.module.NG.$browser
* @requires $log
*
* @description
* Constructor for the object exposed as $browser service.
*
* This object has two goals:
*
* - hide all the global state in the browser caused by the window object
@ -78,8 +75,8 @@ function Browser(window, document, body, XHR, $log, $sniffer) {
/**
* @ngdoc method
* @name angular.service.$browser#xhr
* @methodOf angular.service.$browser
* @name angular.module.NG.$browser#xhr
* @methodOf angular.module.NG.$browser
*
* @param {string} method Requested method (get|post|put|delete|head|json)
* @param {string} url Requested url
@ -157,8 +154,8 @@ function Browser(window, document, body, XHR, $log, $sniffer) {
/**
* @ngdoc method
* @name angular.service.$browser#addPollFn
* @methodOf angular.service.$browser
* @name angular.module.NG.$browser#addPollFn
* @methodOf angular.module.NG.$browser
*
* @param {function()} fn Poll function to add
*
@ -197,8 +194,8 @@ function Browser(window, document, body, XHR, $log, $sniffer) {
/**
* @ngdoc method
* @name angular.service.$browser#url
* @methodOf angular.service.$browser
* @name angular.module.NG.$browser#url
* @methodOf angular.module.NG.$browser
*
* @description
* GETTER:
@ -211,7 +208,7 @@ function Browser(window, document, body, XHR, $log, $sniffer) {
* Returns its own instance to allow chaining
*
* NOTE: this api is intended for use only by the $location service. Please use the
* {@link angular.service.$location $location service} to change url.
* {@link angular.module.NG.$location $location service} to change url.
*
* @param {string} url New url (when used as setter)
* @param {boolean=} replace Should new url replace current history record ?
@ -248,8 +245,8 @@ function Browser(window, document, body, XHR, $log, $sniffer) {
/**
* @ngdoc method
* @name angular.service.$browser#onUrlChange
* @methodOf angular.service.$browser
* @name angular.module.NG.$browser#onUrlChange
* @methodOf angular.module.NG.$browser
* @TODO(vojta): refactor to use node's syntax for events
*
* @description
@ -265,7 +262,7 @@ function Browser(window, document, body, XHR, $log, $sniffer) {
* The listener gets called with new url as parameter.
*
* NOTE: this api is intended for use only by the $location service. Please use the
* {@link angular.service.$location $location service} to monitor url changes in angular apps.
* {@link angular.module.NG.$location $location service} to monitor url changes in angular apps.
*
* @param {function(string)} listener Listener function to be called when url changes.
* @return {function(string)} Returns the registered listener fn - handy if the fn is anonymous.
@ -298,8 +295,8 @@ function Browser(window, document, body, XHR, $log, $sniffer) {
/**
* @ngdoc method
* @name angular.service.$browser#cookies
* @methodOf angular.service.$browser
* @name angular.module.NG.$browser#cookies
* @methodOf angular.module.NG.$browser
*
* @param {string=} name Cookie name
* @param {string=} value Cokkie value
@ -359,8 +356,8 @@ function Browser(window, document, body, XHR, $log, $sniffer) {
/**
* @ngdoc method
* @name angular.service.$browser#defer
* @methodOf angular.service.$browser
* @name angular.module.NG.$browser#defer
* @methodOf angular.module.NG.$browser
* @param {function()} fn A function, who's execution should be defered.
* @param {number=} [delay=0] of milliseconds to defer the function execution.
* @returns {*} DeferId that can be used to cancel the task via `$browser.defer.cancel()`.
@ -388,8 +385,8 @@ function Browser(window, document, body, XHR, $log, $sniffer) {
/**
* THIS DOC IS NOT VISIBLE because ngdocs can't process docs for foo#method.method
*
* @name angular.service.$browser#defer.cancel
* @methodOf angular.service.$browser.defer
* @name angular.module.NG.$browser#defer.cancel
* @methodOf angular.module.NG.$browser.defer
*
* @description
* Cancels a defered task identified with `deferId`.
@ -414,8 +411,8 @@ function Browser(window, document, body, XHR, $log, $sniffer) {
/**
* @ngdoc method
* @name angular.service.$browser#addCss
* @methodOf angular.service.$browser
* @name angular.module.NG.$browser#addCss
* @methodOf angular.module.NG.$browser
*
* @param {string} url Url to css file
* @description
@ -432,8 +429,8 @@ function Browser(window, document, body, XHR, $log, $sniffer) {
/**
* @ngdoc method
* @name angular.service.$browser#addJs
* @methodOf angular.service.$browser
* @name angular.module.NG.$browser#addJs
* @methodOf angular.module.NG.$browser
*
* @param {string} url Url to js file
*