additonal yuidoc

amkirwan · Aug 8, 2015 · 1e62daa · 1e62daa
1 parent 27953df
commit 1e62daa
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/lib/ember-oauth2.js b/lib/ember-oauth2.js
@@ -348,6 +348,7 @@ export default Ember.Object.extend(Ember.Evented, {
    * The key name to use for saving state to localstorage
    *
    * @method stateKeyName
+   * @return {String} The state key name used for localstorage
    */
   stateKeyName: function() {
     return this.get('statePrefix') + '-' + this.get('state');
@@ -358,6 +359,7 @@ export default Ember.Object.extend(Ember.Evented, {
    * The key name to use for saving the token to localstorage
    *
    * @method tokenKeyName
+   * @return {String} The token key name used for localstorage
    */
   tokenKeyName: function() {
     return this.get('tokenPrefix') + '-' + this.get('providerId');
@@ -379,6 +381,10 @@ export default Ember.Object.extend(Ember.Evented, {
 
   /**
    * remove the state from localstorage
+   *
+   * @method removeState
+   * @param {String} stateName The keyname of the state object in localstorage
+   * @return {Object} The deleted state object from localstorage
    */
   removeState: function(stateName) {
     if (stateName) {
@@ -390,6 +396,9 @@ export default Ember.Object.extend(Ember.Evented, {
 
   /**
    * remove the token from localstorage
+   *
+   * @method removeToken
+   * @return {Object} The token object in localstorage
    */
   removeToken: function() {
     return window.localStorage.removeItem(this.tokenKeyName());