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

Commit f158d81

Browse files
committed
docs($browser): hide $browser docs - it's a private service
1 parent 9af7a91 commit f158d81

File tree

2 files changed

+4
-11
lines changed

2 files changed

+4
-11
lines changed

src/ng/browser.js

+2-8
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
'use strict';
22

33
/**
4-
* @ngdoc object
4+
* ! This is a private undocumented service !
5+
*
56
* @name ng.$browser
67
* @requires $log
78
* @description
@@ -86,7 +87,6 @@ function Browser(window, document, $log, $sniffer) {
8687
pollTimeout;
8788

8889
/**
89-
* @ngdoc method
9090
* @name ng.$browser#addPollFn
9191
* @methodOf ng.$browser
9292
*
@@ -127,7 +127,6 @@ function Browser(window, document, $log, $sniffer) {
127127
baseElement = document.find('base');
128128

129129
/**
130-
* @ngdoc method
131130
* @name ng.$browser#url
132131
* @methodOf ng.$browser
133132
*
@@ -183,7 +182,6 @@ function Browser(window, document, $log, $sniffer) {
183182
}
184183

185184
/**
186-
* @ngdoc method
187185
* @name ng.$browser#onUrlChange
188186
* @methodOf ng.$browser
189187
* @TODO(vojta): refactor to use node's syntax for events
@@ -249,7 +247,6 @@ function Browser(window, document, $log, $sniffer) {
249247
var cookiePath = self.baseHref();
250248

251249
/**
252-
* @ngdoc method
253250
* @name ng.$browser#cookies
254251
* @methodOf ng.$browser
255252
*
@@ -308,7 +305,6 @@ function Browser(window, document, $log, $sniffer) {
308305

309306

310307
/**
311-
* @ngdoc method
312308
* @name ng.$browser#defer
313309
* @methodOf ng.$browser
314310
* @param {function()} fn A function, who's execution should be defered.
@@ -336,8 +332,6 @@ function Browser(window, document, $log, $sniffer) {
336332

337333

338334
/**
339-
* THIS DOC IS NOT VISIBLE because ngdocs can't process docs for foo#method.method
340-
*
341335
* @name ng.$browser#defer.cancel
342336
* @methodOf ng.$browser.defer
343337
*

src/ngMock/angular-mocks.js

+2-3
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@
1717
angular.mock = {};
1818

1919
/**
20-
* @ngdoc object
20+
* ! This is a private undocumented service !
21+
*
2122
* @name ngMock.$browser
2223
*
2324
* @description
@@ -95,7 +96,6 @@ angular.mock.$Browser = function() {
9596

9697

9798
/**
98-
* @ngdoc method
9999
* @name ngMock.$browser#defer.flush
100100
* @methodOf ngMock.$browser
101101
*
@@ -120,7 +120,6 @@ angular.mock.$Browser = function() {
120120
}
121121
};
122122
/**
123-
* @ngdoc property
124123
* @name ngMock.$browser#defer.now
125124
* @propertyOf ngMock.$browser
126125
*

0 commit comments

Comments
 (0)