From 6c2a28aba296dc41bc168089e0f5a9d423b06620 Mon Sep 17 00:00:00 2001
From: Victor Woeltjen <victor.woeltjen@nasa.gov>
Date: Mon, 21 Mar 2016 16:05:05 -0700
Subject: [PATCH] [Add] Add JSDoc to model cache

---
 platform/core/src/models/ModelCacheService.js | 31 +++++++++++++++++++
 1 file changed, 31 insertions(+)

diff --git a/platform/core/src/models/ModelCacheService.js b/platform/core/src/models/ModelCacheService.js
index ee6edd522c..67a143935f 100644
--- a/platform/core/src/models/ModelCacheService.js
+++ b/platform/core/src/models/ModelCacheService.js
@@ -24,29 +24,60 @@
 define([], function () {
     'use strict';
 
+    /**
+     * Provides a cache for domain object models which exist in memory,
+     * but may or may not exist in backing persistene stores.
+     * @constructor
+     * @memberof platform/core
+     */
     function ModelCacheService() {
         this.cache = {};
         this.cached = {};
     }
 
+    /**
+     * Put a domain object model in the cache.
+     * @param {string} id the domain object's identifier
+     * @param {object} model the domain object's model
+     */
     ModelCacheService.prototype.put = function (id, model) {
         this.cached[id] = true;
         this.cache[id] = model;
     };
 
+    /**
+     * Retrieve a domain object model from the cache.
+     * @param {string} id the domain object's identifier
+     * @returns {object} the domain object's model
+     */
     ModelCacheService.prototype.get = function (id) {
         return this.cache[id];
     };
 
+    /**
+     * Check if a domain object model is in the cache.
+     * @param {string} id the domain object's identifier
+     * @returns {boolean} true if present; false if not
+     */
     ModelCacheService.prototype.has = function (id) {
         return this.cached[id];
     };
 
+    /**
+     * Remove a domain object model from the cache.
+     * @param {string} id the domain object's identifier
+     */
     ModelCacheService.prototype.remove = function (id) {
         delete this.cached[id];
         delete this.cache[id];
     };
 
+    /**
+     * Retrieve all cached domain object models. These are given
+     * as an object containing key-value pairs, where keys are
+     * domain object identifiers and values are domain object models.
+     * @returns {object} all domain object models
+     */
     ModelCacheService.prototype.all = function () {
         return this.cache;
     };