aboutsummaryrefslogtreecommitdiffstats
path: root/src/service/location.js
diff options
context:
space:
mode:
authorMisko Hevery2011-11-10 18:47:47 -0800
committerMisko Hevery2011-11-14 20:31:18 -0800
commitb09595a3c12ba761772084b94767b635c5bbfaf2 (patch)
treea86f45599ee86964ea2bd09e5c336280ef98a769 /src/service/location.js
parentf6d98f1472338a77b2f146087bcb8560f472e5d1 (diff)
downloadangular.js-b09595a3c12ba761772084b94767b635c5bbfaf2.tar.bz2
fix(doc) cleanup all api doc link warnings
Diffstat (limited to 'src/service/location.js')
-rw-r--r--src/service/location.js24
1 files changed, 23 insertions, 1 deletions
diff --git a/src/service/location.js b/src/service/location.js
index 4d82dfae..532ee3af 100644
--- a/src/service/location.js
+++ b/src/service/location.js
@@ -401,7 +401,6 @@ function locationGetterSetter(property, preprocess) {
*
* @requires $browser
* @requires $sniffer
- * @requires $locationConfig
* @requires $document
*
* @description
@@ -420,10 +419,25 @@ function locationGetterSetter(property, preprocess) {
*
* For more information see {@link guide/dev_guide.services.$location Developer Guide: Angular Services: Using $location}
*/
+
+/**
+ * @ngdoc object
+ * @name angular.module.NG.$locationProvider
+ * @description
+ * Use the `$locationPrvoder` to configure how the application deep linking paths are stored.
+ */
function $LocationProvider(){
var hashPrefix = '',
html5Mode = false;
+ /**
+ * @ngdoc property
+ * @name angular.module.NG.$locationProvider#hashPrefix
+ * @methodOf angular.module.NG.$locationProvider
+ * @description
+ * @param {string=} prefix Prefix for hash part (containing path and search)
+ * @returns current value if used as getter or itself (chaining) if used as setter
+ */
this.hashPrefix = function(prefix) {
if (isDefined(prefix)) {
hashPrefix = prefix;
@@ -433,6 +447,14 @@ function $LocationProvider(){
}
}
+ /**
+ * @ngdoc property
+ * @name angular.module.NG.$locationProvider#hashPrefix
+ * @propertyOf angular.module.NG.$locationProvider
+ * @description
+ * @param mode= Use HTML5 strategy if available.
+ * @returns current value if used as getter or itself (chaining) if used as setter
+ */
this.html5Mode = function(mode) {
if (isDefined(mode)) {
html5Mode = mode;