js-doc

babel/babel-eslint#85

I fixed some issues, but more...

Want to get team feedback on whether or not this is useful.

Author: justin808

client/.eslintrc

@@ -239,7 +239,7 @@
 
   // https://github.com/babel/babel-eslint/issues/85
   // Disabling until this issue is resolved
-  "valid-jsdoc": 0,
+  "valid-jsdoc": 2,
 
   "valid-typeof": 2,
   "wrap-iife": 0,

client/assets/javascripts/actions/CommentActions.js

@@ -7,7 +7,7 @@ class CommentActions {
    *
    * @param {String} url
    * @param {Boolean} displaySpinner
-   * @return undefined
+   * @returns {undefined}
    */
   fetchComments(url, displaySpinner) {
     this.dispatch(displaySpinner);
@@ -20,7 +20,7 @@ class CommentActions {
    * A new list of comments is available, refresh the store.
    *
    * @param {Array} comments
-   * @return undefined
+   *  @returns {undefined}
    */
   updateComments(comments) {
     this.dispatch(comments);
@@ -30,7 +30,7 @@ class CommentActions {
    * An error occurred while fetching comments, dispatch error message.
    *
    * @param {String} errorMessage
-   * @return undefined
+   *  @returns {undefined}
    */
   updateCommentsError(errorMessage) {
     this.dispatch(errorMessage);
@@ -40,7 +40,7 @@ class CommentActions {
    * A new comment has been submitted to the server, dispatch it.
    *
    * @param {Array} comment
-   * @return undefined
+   *  @returns {undefined}
    */
   addComment(comment) {
     this.dispatch(comment);

client/assets/javascripts/actions/FormActions.js

@@ -7,7 +7,7 @@ class FormActions {
    * Text is being entered in the comment form, update the state.
    *
    * @param {String} comment
-   * @return undefined
+   *  @returns {undefined}
    */
   updateComment(comment) {
     this.dispatch(comment);
@@ -17,7 +17,7 @@ class FormActions {
    * Submit a new comment to the server.
    *
    * @param {String} comment
-   * @return undefined
+   *  @returns {undefined}
    */
   submitComment(url, comment) {
     this.dispatch();

client/assets/javascripts/utils/CommentsManager.js

@@ -5,7 +5,7 @@ const CommentsManager = {
    * Retrieve comments from server using AJAX call.
    *
    * @param {String} url
-   * @return Object
+   *  @returns {Object}
    */
   fetchComments(url) {
     return $.ajax({
@@ -19,7 +19,7 @@ const CommentsManager = {
    *
    * @param {String} url
    * @param {Object} comment
-   * @return Object
+   *  @returns {Object}
    */
   submitComment(url, comment) {
     return $.ajax({