Revised angular-cache documentation.

Author: jmdobry

guide/angular-cache/basics.doc

@@ -4,13 +4,13 @@
 @description
 
 ## Create a cache
-First, inject `$angularCacheFactory` then create as many caches as you so desire. Let's go:
+First, inject `DSCacheFactory` then create as many caches as you so desire. Let's go:
 
 ```javascript
-app.service('myService', function ($angularCacheFactory) {
+app.service('myService', function (DSCacheFactory) {
 
     // Create a new cache called "profileCache"
-    var profileCache = $angularCacheFactory('profileCache');
+    var profileCache = DSCacheFactory('profileCache');
 });
 ```
 
@@ -61,7 +61,7 @@ profileCache.setOptions({
 Sweet! Now we'd probably have configured our cache correctly when we created it:
 
 ```javascript
-var profileCache = $angularCacheFactory('profileCache', {
+var profileCache = DSCacheFactory('profileCache', {
     maxAge: 3600000,
     deleteOnExpire: 'aggressive',
     onExpire: function (key, value) {
@@ -75,10 +75,10 @@ var profileCache = $angularCacheFactory('profileCache', {
 Or say we want all of our caches to use that configuration as their default:
 
 ```javascript
-angular.module('app', ['jmdobry.angular-cache'])
-    .config(function ($angularCacheFactoryProvider) {
+angular.module('app', ['angular-data.DSCacheFactory'])
+    .config(function (DSCacheFactoryProvider) {
 
-        $angularCacheFactoryProvider.setCacheDefaults({
+        DSCacheFactoryProvider.setCacheDefaults({
             maxAge: 3600000,
                 deleteOnExpire: 'aggressive',
                 onExpire: function (key, value) {
@@ -128,7 +128,7 @@ profileCache.get('/profiles/34'); // undefined
 
 profileCache.destroy();
 
-$angularCacheFactory.get('profileCache'); // undefined
+DSCacheFactory.get('profileCache'); // undefined
 ```
 
-See the [API Documentation](api.html) for more information on the available methods.
+See the [API Documentation](/documentation/api/angular-cache/angular-cache) for more information on the available methods.

guide/angular-cache/configure.doc

@@ -3,13 +3,13 @@
 @name Configure a cache
 @description
 
-See [Configuration Options](configuration.html) for information on the available configuration options.
+See the [API Documentation](/documentation/api/angular-cache/angular-cache) for information on the available configuration options.
 
 #### Dynamically configure a cache
 ```javascript
-app.service('myService', function ($angularCacheFactory) {
+app.service('myService', function (DSCacheFactory) {
 
-    var cache = $angularCacheFactory('cache', {
+    var cache = DSCacheFactory('cache', {
         capacity: 100,
         maxAge: 300000
     });
@@ -40,4 +40,4 @@ app.service('myService', function ($angularCacheFactory) {
     cache.info('someItem'); // { maxAge: 12000, deleteOnExpire: 'aggressive', isExpired: false, ... }
 });
 ```
-See [AngularCache.setOptions(options)](api.html#cachesetoptions).
+See the [API Documentation](/documentation/api/angular-cache/angular-cache) for more information.

guide/angular-cache/http.doc

@@ -7,17 +7,17 @@
 
 __Note__ The downside of letting $http handle caching for you is that it caches the responses (in string form) to your requests–not the JavaScript Object parsed from the response body. This means you can't interact with the data in the cache used by `$http`. See below for how to handle the caching yourself–giving you more control and the ability to interact with the cache (use it as a data store).
 
-Configure `$http` to use a cache created by `$angularCacheFactory` by default:
+Configure `$http` to use a cache created by `DSCacheFactory` by default:
 ```javascript
-app.run(function ($http, $angularCacheFactory) {
+app.run(function ($http, DSCacheFactory) {
 
-    $angularCacheFactory('defaultCache', {
+    DSCacheFactory('defaultCache', {
         maxAge: 900000, // Items added to this cache expire after 15 minutes.
         cacheFlushInterval: 6000000, // This cache will clear itself every hour.
         deleteOnExpire: 'aggressive' // Items will be deleted from this cache right when they expire.
     });
 
-    $http.defaults.cache = $angularCacheFactory.get('defaultCache');
+    $http.defaults.cache = DSCacheFactory.get('defaultCache');
 });
 
 app.service('myService', function ($http) {
@@ -50,11 +50,11 @@ app.controller('myCtrl', function (myService) {
 });
 ```
 
-Tell `$http` to use a cache created by `$angularCacheFactory` for a specific request:
+Tell `$http` to use a cache created by `DSCacheFactory` for a specific request:
 ```javascript
-app.service('myService', function ($http, $angularCacheFactory) {
+app.service('myService', function ($http, DSCacheFactory) {
 
-    $angularCacheFactory('dataCache', {
+    DSCacheFactory('dataCache', {
         maxAge: 90000, // Items added to this cache expire after 15 minutes.
         cacheFlushInterval: 600000, // This cache will clear itself every hour.
         deleteOnExpire: 'aggressive' // Items will be deleted from this cache right when they expire.
@@ -66,7 +66,7 @@ app.service('myService', function ($http, $angularCacheFactory) {
                 start = new Date().getTime();
 
             $http.get('api/data/' + id, {
-                cache: $angularCacheFactory.get('dataCache')
+                cache: DSCacheFactory.get('dataCache')
             }).success(function (data) {
                 console.log('time taken for request: ' + (new Date().getTime() - start) + 'ms');
                 deferred.resolve(data);
@@ -91,9 +91,9 @@ app.controller('myCtrl', function (myService) {
 
 Do your own caching while using the $http service:
 ```javascript
-app.service('myService', function ($http, $angularCacheFactory) {
+app.service('myService', function ($http, DSCacheFactory) {
 
-    $angularCacheFactory('dataCache', {
+    DSCacheFactory('dataCache', {
         maxAge: 900000, // Items added to this cache expire after 15 minutes.
         cacheFlushInterval: 3600000, // This cache will clear itself every hour.
         deleteOnExpire: 'aggressive' // Items will be deleted from this cache right when they expire.
@@ -103,7 +103,7 @@ app.service('myService', function ($http, $angularCacheFactory) {
         getDataById: function (id) {
             var deferred = $q.defer(),
                 start = new Date().getTime(),
-                dataCache = $angularCacheFactory.get('dataCache');
+                dataCache = DSCacheFactory.get('dataCache');
 
             // Now that control of inserting/removing from the cache is in our hands,
             // we can interact with the data in "dataCache" outside of this context,

guide/angular-cache/storage.doc

@@ -6,12 +6,12 @@
 #### Using angular-cache with localStorage (or sessionStorage)
 Using angular-cache in browsers that support localStorage:
 ```javascript
-app.service('myService', function ($angularCacheFactory) {
+app.service('myService', function (DSCacheFactory) {
 
     // This cache will sync itself with localStorage if it exists, otherwise it won't. Every time the
     // browser loads this app, this cache will attempt to initialize itself with any data it had
     // already saved to localStorage (or sessionStorage if you used that).
-    var myAwesomeCache = $angularCacheFactory('myAwesomeCache', {
+    var myAwesomeCache = DSCacheFactory('myAwesomeCache', {
         maxAge: 900000, // Items added to this cache expire after 15 minutes.
         cacheFlushInterval: 3600000, // This cache will clear itself every hour.
         deleteOnExpire: 'aggressive', // Items will be deleted from this cache right when they expire.
@@ -28,7 +28,7 @@ Option 2 - Create/use a polyfill that provides the global `localStorage` and `se
 
 Option 3 - Tell angular-cache exactly which polyfill to use (also useful if you just want to use your own implementation/wrapper for localStorage):
 ```javascript
-app.service('myService', function ($angularCacheFactory) {
+app.service('myService', function (DSCacheFactory) {
 
     var localStoragePolyfill = {
         getItem: function (key) { ... },
@@ -37,7 +37,7 @@ app.service('myService', function ($angularCacheFactory) {
     };
 
     // Always use the polyfill
-    var myAwesomeCache = $angularCacheFactory('myAwesomeCache', {
+    var myAwesomeCache = DSCacheFactory('myAwesomeCache', {
         maxAge: 900000, // Items added to this cache expire after 15 minutes.
         cacheFlushInterval: 3600000, // This cache will clear itself every hour.
         deleteOnExpire: 'aggressive', // Items will be deleted from this cache right when they expire.
@@ -55,7 +55,7 @@ app.service('myService', function ($angularCacheFactory) {
     if (!window.localStorage) {
         options.storageImpl = localStoragePolyfill;
     }
-    var myAwesomeCache = $angularCacheFactory('myAwesomeCache', options);
+    var myAwesomeCache = DSCacheFactory('myAwesomeCache', options);
 });
 ```
 
@@ -84,7 +84,7 @@ var storeJsToStandard {
   removeItem: store.remove
 };
 
-$angularCacheFactory('myNewCache', {
+DSCacheFactory('myNewCache', {
   storageMode: 'localStorage',
   storageImpl: storeJsToStandard
 });