1 files changed, 65 insertions, 0 deletions

diff --git a/app/scripts/controllers/currency.js b/app/scripts/controllers/currency.js
index 36b8808aa..275219ce4 100644
--- a/app/scripts/controllers/currency.js
+++ b/app/scripts/controllers/currency.js
@@ -6,6 +6,22 @@ const POLLING_INTERVAL = 600000
 
 class CurrencyController {
 
+	/**
+	 * Controller responsible for managing data associated with the currently selected currency.
+	 *
+   * @typedef {Object} CurrencyController
+	 * @param {object} opts Overides the defaults for the initial state of this.store
+	 * @property {array} opts.initState  initializes the the state of the CurrencyController. Can contain an
+   * currentCurrency, conversionRate and conversionDate properties
+   * @property {string} currentCurrency A 2-4 character shorthand that describes a specific currency, currently
+   * selected by the user
+   * @property {number} conversionRate The conversion rate from ETH to the selected currency. 
+   * @property {string} conversionDate The date at which the conversion rate was set. Expressed in in milliseconds
+   * since midnight of January 1, 1970 
+   * @property {number} conversionInterval The id of the interval created by the scheduleConversionInterval method.
+   * Used to clear an existing interval on subsequent calls of that method.
+	 *
+	 */
   constructor (opts = {}) {
     const initState = extend({
       currentCurrency: 'usd',
@@ -19,30 +35,73 @@ class CurrencyController {
   // PUBLIC METHODS
   //
 
+	/**
+	 * A getter for the currentCurrency property
+	 *
+	 * @returns {string} A 2-4 character shorthand that describes a specific currency, currently selected by the user
+	 *
+	 */
   getCurrentCurrency () {
     return this.store.getState().currentCurrency
   }
 
+	/**
+	 * A setter for the currentCurrency property
+	 *
+	 * @params {string} currentCurrency The new currency to set as the currentCurrency in the store
+	 *
+	 */
   setCurrentCurrency (currentCurrency) {
     this.store.updateState({ currentCurrency })
   }
 
+  /**
+   * A getter for the conversionRate property
+   *
+   * @returns {string} The conversion rate from ETH to the selected currency. 
+   *
+   */
   getConversionRate () {
     return this.store.getState().conversionRate
   }
 
+  /**
+   * A setter for the conversionRate property
+   *
+   * @params {number} conversionRate The new rate to set as the conversionRate in the store
+   *
+   */
   setConversionRate (conversionRate) {
     this.store.updateState({ conversionRate })
   }
 
+  /**
+   * A getter for the conversionDate property
+   *
+   * @returns {string} The date at which the conversion rate was set. Expressed in milliseconds since midnight of
+   * January 1, 1970 
+   *
+   */
   getConversionDate () {
     return this.store.getState().conversionDate
   }
 
+  /**
+   * A setter for the conversionDate property
+   *
+   * @params {number} conversionDate The date, expressed in milliseconds since midnight of January 1, 1970, that the
+   * conversionRate was set
+   *
+   */
   setConversionDate (conversionDate) {
     this.store.updateState({ conversionDate })
   }
 
+  /**
+   * Updates the conversionRate and conversionDate properties associated with the currentCurrency. Updated info is
+   * fetched from an external API
+   *
+   */
   async updateConversionRate () {
     let currentCurrency
     try {
@@ -58,6 +117,12 @@ class CurrencyController {
     }
   }
 
+	/**
+	 * Creates a new poll, using setInterval, to periodically call updateConversionRate. The id of the interval is
+   * stored at the controller's conversionInterval property. If it is called and such an id already exists, the
+   * previous interval is clear and a new one is created.
+	 *
+	 */
   scheduleConversionInterval () {
     if (this.conversionInterval) {
       clearInterval(this.conversionInterval)