Documentation for various controllers and libs

1 files changed, 10 insertions, 0 deletions

diff --git a/app/scripts/lib/buy-eth-url.js b/app/scripts/lib/buy-eth-url.js
index b9dde3c28..c7c7bc33c 100644
--- a/app/scripts/lib/buy-eth-url.js
+++ b/app/scripts/lib/buy-eth-url.js
@@ -1,5 +1,15 @@
 module.exports = getBuyEthUrl
 
+/**
+ * Gives the caller a url at which the user can acquire eth, depending on the network they are in
+ *
+ * @param {object} opts Options required to determine the correct url
+ * @param {string} opts.network The network for which to return a url
+ * @param {string} opts.amount The amount of ETH to buy on coinbase. Only relevant if network === '1'.
+ * @param {string} opts.address The adderss the bought ETH should be sent to.  Only relevant if network === '1'.
+ * @returns {string} The url at which the user can access ETH, while in the given network
+ *
+ */
 function getBuyEthUrl ({ network, amount, address }) {
   let url
   switch (network) {