Cleans up docs for auth actions

Author: birdofpreyru

bin/docgen

@@ -10,6 +10,9 @@ const fs = require('fs');
 const jsdoc2md = require('jsdoc-to-markdown');
 const mkpath = require('mkpath');
 const path = require('path');
+const rimraf = require('rimraf');
+
+rimraf.sync(path.resolve(__dirname, '../_auto_doc_'));
 
 const outputDir = path.resolve(__dirname, '../_auto_doc_');
 

src/actions/auth.js

@@ -1,19 +1,17 @@
 /**
- * @module actions/auth
- * @desc Auth-related actions.
+ * @module "actions.auth"
+ * @desc Actions related to Topcoder authentication system.
  */
 
-import _ from 'lodash';
 import { createActions } from 'redux-actions';
 import { decodeToken } from 'tc-accounts';
 import { getApiV3 } from '../services/api';
 
 /**
- * Loads profile of the authenticated user.
- * @alias module:actions/auth
- * @param {String} userTokenV3 Topcoder auth token V3.
- * @return {Promise}
- * @fulfil {Object} User profile object.
+ * @static
+ * @desc Creates an action that loads Topcoder user profile from v3 API.
+ * @param {String} userTokenV3 v3 authentication token.
+ * @return {Action}
  */
 function loadProfileDone(userTokenV3) {
   if (!userTokenV3) return Promise.resolve(null);
@@ -30,20 +28,31 @@ function loadProfileDone(userTokenV3) {
 }
 
 /**
- * @function test
- * @desc test
+ * @static
+ * @desc Creates an action that sets Topcoder v2 authentication token.
+ * @param {String} tokenV2 Topcoder v2 authentication token.
+ * @return {Action}
  */
+function setTcTokenV2(tokenV2) {
+  return tokenV2;
+}
+
+/**
+ * @static
+ * @desc Creates an action that decodes Topcoder v3 authentication token,
+ * to get user object, and then writes both the token and the user object into
+ * Redux store.
+ * @param {String} tokenV3 Topcoder v3 authentication token.
+ * @return {Action}
+ */
+function setTcTokenV3(tokenV3) {
+  return tokenV3;
+}
 
 export default createActions({
   AUTH: {
     LOAD_PROFILE: loadProfileDone,
-
-    /* Given TC auth token V2, this action writes it into state.auth.tokenV2. */
-    SET_TC_TOKEN_V2: _.identity,
-
-    /* Given TC auth token V3 this action:
-     *  - Decodes token and writes resulting user object into state.auth.user;
-     *  - Writes the token itself into state.auth.tokenV3. */
-    SET_TC_TOKEN_V3: _.identity,
+    SET_TC_TOKEN_V2: setTcTokenV2,
+    SET_TC_TOKEN_V3: setTcTokenV3,
   },
 });