docs($rootScope): rename ttl to digestTtl + docs

IgorMinar · IgorMinar · commit e0ace15cd325 · 2012-03-08T11:01:22.000-08:00
diff --git a/src/service/scope.js b/src/service/scope.js
@@ -25,6 +25,30 @@
  * are expensive to construct.
  */
 
+
+/**
+ * @ngdoc object
+ * @name angular.module.ng.$rootScopeProvider
+ * @description
+ *
+ * Provider for the $rootScope service.
+ */
+
+/**
+ * @ngdoc function
+ * @name angular.module.ng.$rootScopeProvider#digestTtl
+ * @methodOf angular.module.ng.$rootScopeProvider
+ * @description
+ *
+ * Sets the number of digest iteration the scope should attempt to execute before giving up and
+ * assuming that the model is unstable.
+ *
+ * The current default is 10 iterations.
+ *
+ * @param {number} limit The number of digest iterations.
+ */
+
+
 /**
  * @ngdoc object
  * @name angular.module.ng.$rootScope
@@ -37,7 +61,7 @@
 function $RootScopeProvider(){
   var TTL = 10;
 
-  this.ttl = function(value) {
+  this.digestTtl = function(value) {
     if (arguments.length) {
       TTL = value;
     }
diff --git a/test/service/scopeSpec.js b/test/service/scopeSpec.js
@@ -191,7 +191,7 @@ describe('Scope', function() {
 
     it('should prevent infinite recursion and print watcher expression',function() {
       module(function($rootScopeProvider) {
-        $rootScopeProvider.ttl(100);
+        $rootScopeProvider.digestTtl(100);
       });
       inject(function($rootScope) {
         $rootScope.$watch('a', function() {$rootScope.b++;});
