[CHORE] update comments

This commit is contained in:
Matthew Fettig
2014-05-19 16:50:02 -07:00
parent 7ea1ba168d
commit 1693a57845
2 changed files with 13 additions and 7 deletions

View File

@@ -5,7 +5,12 @@ function AuthInfo () {
this.rippleTxt = new RippleTxt; this.rippleTxt = new RippleTxt;
} }
//Can I cache the auth info for later use? /**
* Get auth info for a given username
* @param {string} domain - Domain which hosts the user's info
* @param {string} username - Username who's info we are retreiving
* @param {function} fn - Callback function
*/
AuthInfo.prototype.get = function (domain, username, fn) { AuthInfo.prototype.get = function (domain, username, fn) {
var self = this; var self = this;

View File

@@ -1,14 +1,15 @@
var request = require('superagent'); var request = require('superagent');
function RippleTxt(opts) { function RippleTxt() {
this.txts = {}; this.txts = {};
}; };
/* /**
* Gets the ripple.txt file for the given domain * Gets the ripple.txt file for the given domain
* * @param {string} domain - Domain to retrieve file from
* @param {function} fn - Callback function
*/ */
RippleTxt.prototype.get = function (domain, fn) { RippleTxt.prototype.get = function (domain, fn) {
var self = this; var self = this;
@@ -40,9 +41,9 @@ RippleTxt.prototype.get = function (domain, fn) {
} }
/* /**
* parse a ripple.txt file * Parse a ripple.txt file
* * @param {string} txt - Unparsed ripple.txt data
*/ */
RippleTxt.prototype.parse = function (txt) { RippleTxt.prototype.parse = function (txt) {