diff options
| author | Igor Minar | 2012-06-11 23:49:24 -0700 |
|---|---|---|
| committer | Igor Minar | 2012-06-12 00:10:18 -0700 |
| commit | f16150d5f1b20b3d633b4402095ea89baa4be042 (patch) | |
| tree | 9d5c570348264884174ecca52b958da7a821fcf8 /src/ng/browser.js | |
| parent | fc0b2b5715655a05cbb4c8e79969c95d7e7ce8b7 (diff) | |
| download | angular.js-f16150d5f1b20b3d633b4402095ea89baa4be042.tar.bz2 | |
docs(*): simplify doc urls
we now have two types of namespaces:
- true namespace: angular.* - used for all global apis
- virtual namespace: ng.*, ngMock.*, ... - used for all DI modules
the virual namespaces have services under the second namespace level (e.g. ng.)
and filters and directives prefixed with filter: and directive: respectively
(e.g. ng.filter:orderBy, ng.directive:ngRepeat)
this simplifies urls and makes them a lot shorter while still avoiding name collisions
Diffstat (limited to 'src/ng/browser.js')
| -rw-r--r-- | src/ng/browser.js | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/src/ng/browser.js b/src/ng/browser.js index 16a5582f..0bace2e8 100644 --- a/src/ng/browser.js +++ b/src/ng/browser.js @@ -2,7 +2,7 @@ /** * @ngdoc object - * @name angular.module.ng.$browser + * @name ng.$browser * @requires $log * @description * This object has two goals: @@ -10,7 +10,7 @@ * - hide all the global state in the browser caused by the window object * - abstract away all the browser specific features and inconsistencies * - * For tests we provide {@link angular.module.ngMock.$browser mock implementation} of the `$browser` + * For tests we provide {@link ngMock.$browser mock implementation} of the `$browser` * service, which can be used for convenient testing of the application without the interaction with * the real browser apis. */ @@ -87,8 +87,8 @@ function Browser(window, document, $log, $sniffer) { /** * @ngdoc method - * @name angular.module.ng.$browser#addPollFn - * @methodOf angular.module.ng.$browser + * @name ng.$browser#addPollFn + * @methodOf ng.$browser * * @param {function()} fn Poll function to add * @@ -128,8 +128,8 @@ function Browser(window, document, $log, $sniffer) { /** * @ngdoc method - * @name angular.module.ng.$browser#url - * @methodOf angular.module.ng.$browser + * @name ng.$browser#url + * @methodOf ng.$browser * * @description * GETTER: @@ -142,7 +142,7 @@ function Browser(window, document, $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.module.ng.$location $location service} to change url. + * {@link 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 ? @@ -184,8 +184,8 @@ function Browser(window, document, $log, $sniffer) { /** * @ngdoc method - * @name angular.module.ng.$browser#onUrlChange - * @methodOf angular.module.ng.$browser + * @name ng.$browser#onUrlChange + * @methodOf ng.$browser * @TODO(vojta): refactor to use node's syntax for events * * @description @@ -201,7 +201,7 @@ function Browser(window, document, $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.module.ng.$location $location service} to monitor url changes in angular apps. + * {@link 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. @@ -250,8 +250,8 @@ function Browser(window, document, $log, $sniffer) { /** * @ngdoc method - * @name angular.module.ng.$browser#cookies - * @methodOf angular.module.ng.$browser + * @name ng.$browser#cookies + * @methodOf ng.$browser * * @param {string=} name Cookie name * @param {string=} value Cokkie value @@ -309,8 +309,8 @@ function Browser(window, document, $log, $sniffer) { /** * @ngdoc method - * @name angular.module.ng.$browser#defer - * @methodOf angular.module.ng.$browser + * @name ng.$browser#defer + * @methodOf 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()`. @@ -338,8 +338,8 @@ function Browser(window, document, $log, $sniffer) { /** * THIS DOC IS NOT VISIBLE because ngdocs can't process docs for foo#method.method * - * @name angular.module.ng.$browser#defer.cancel - * @methodOf angular.module.ng.$browser.defer + * @name ng.$browser#defer.cancel + * @methodOf ng.$browser.defer * * @description * Cancels a defered task identified with `deferId`. |
