Fix some stuffwinh-jsdoc

18 files changed, 80 insertions, 10 deletions

diff --git a/app/assets/javascripts/commit/pipelines/pipelines_bundle.js b/app/assets/javascripts/commit/pipelines/pipelines_bundle.js
index 340a93e4e66..7583892ac7d 100644
--- a/app/assets/javascripts/commit/pipelines/pipelines_bundle.js
+++ b/app/assets/javascripts/commit/pipelines/pipelines_bundle.js
@@ -1,3 +1,7 @@
+/**
+ *
+ */
+
 import Vue from 'vue';
 import commitPipelinesTable from './pipelines_table.vue';
 
diff --git a/app/assets/javascripts/diffs/store/getters.js b/app/assets/javascripts/diffs/store/getters.js
index fdf1efbb10e..607fabbbaf1 100644
--- a/app/assets/javascripts/diffs/store/getters.js
+++ b/app/assets/javascripts/diffs/store/getters.js
@@ -1,3 +1,7 @@
+/**
+ * @module Diffs store getters
+ */
+
 import { PARALLEL_DIFF_VIEW_TYPE, INLINE_DIFF_VIEW_TYPE } from '../constants';
 
 export const isParallelView = state => state.diffViewType === PARALLEL_DIFF_VIEW_TYPE;
diff --git a/app/assets/javascripts/dropzone_input.js b/app/assets/javascripts/dropzone_input.js
index 9987fbcb6a7..1ddb007cb78 100644
--- a/app/assets/javascripts/dropzone_input.js
+++ b/app/assets/javascripts/dropzone_input.js
@@ -1,3 +1,7 @@
+/**
+ * @module dropzone-input
+ */
+
 import $ from 'jquery';
 import Dropzone from 'dropzone';
 import _ from 'underscore';
diff --git a/app/assets/javascripts/ide/index.js b/app/assets/javascripts/ide/index.js
index fbf944499d5..f02abe10399 100644
--- a/app/assets/javascripts/ide/index.js
+++ b/app/assets/javascripts/ide/index.js
@@ -1,3 +1,4 @@
+
 import Vue from 'vue';
 import { mapActions } from 'vuex';
 import Translate from '~/vue_shared/translate';
@@ -9,12 +10,18 @@ import { parseBoolean } from '../lib/utils/common_utils';
 Vue.use(Translate);
 
 /**
+ * Function that returns extra properties to seed initial data.
+ * @callback extraInitialData
+ * @param {Element}
+ * @return {Object}
+ */
+
+/**
  * Initialize the IDE on the given element.
  *
  * @param {Element} el - The element that will contain the IDE.
  * @param {Object} options - Extra options for the IDE (Used by EE).
- * @param {(e:Element) => Object} options.extraInitialData -
- *   Function that returns extra properties to seed initial data.
+ * @param {extraInitialData} options.extraInitialData
  * @param {Component} options.rootComponent -
  *   Component that overrides the root component.
  */
diff --git a/app/assets/javascripts/issuable_bulk_update_actions.js b/app/assets/javascripts/issuable_bulk_update_actions.js
index b844e4c5e5b..db81c663897 100644
--- a/app/assets/javascripts/issuable_bulk_update_actions.js
+++ b/app/assets/javascripts/issuable_bulk_update_actions.js
@@ -1,5 +1,9 @@
 /* eslint-disable consistent-return, func-names, array-callback-return, prefer-arrow-callback, no-unused-vars */
 
+/**
+ * @module IssuableBulkUpdateActions
+ */
+
 import $ from 'jquery';
 import _ from 'underscore';
 import axios from './lib/utils/axios_utils';
diff --git a/app/assets/javascripts/jobs/store/actions.js b/app/assets/javascripts/jobs/store/actions.js
index 8045f6dc3ff..272f9eae802 100644
--- a/app/assets/javascripts/jobs/store/actions.js
+++ b/app/assets/javascripts/jobs/store/actions.js
@@ -1,3 +1,7 @@
+/**
+ * @module Jobs store actions
+ */
+
 import Visibility from 'visibilityjs';
 import * as types from './mutation_types';
 import axios from '~/lib/utils/axios_utils';
diff --git a/app/assets/javascripts/jobs/store/mutations.js b/app/assets/javascripts/jobs/store/mutations.js
index cd440d21c1f..abc3e2e2e1f 100644
--- a/app/assets/javascripts/jobs/store/mutations.js
+++ b/app/assets/javascripts/jobs/store/mutations.js
@@ -1,3 +1,7 @@
+/**
+ * @module jobs-store-mutations
+ */
+
 import * as types from './mutation_types';
 
 export default {
diff --git a/app/assets/javascripts/lib/utils/axios_utils.js b/app/assets/javascripts/lib/utils/axios_utils.js
index 69159e2d741..54ac566c993 100644
--- a/app/assets/javascripts/lib/utils/axios_utils.js
+++ b/app/assets/javascripts/lib/utils/axios_utils.js
@@ -1,3 +1,7 @@
+/**
+ * @module axios-utils
+ */
+
 import axios from 'axios';
 import csrf from './csrf';
 
diff --git a/app/assets/javascripts/lib/utils/bootstrap_linked_tabs.js b/app/assets/javascripts/lib/utils/bootstrap_linked_tabs.js
index a24c71aeab1..0125c624598 100644
--- a/app/assets/javascripts/lib/utils/bootstrap_linked_tabs.js
+++ b/app/assets/javascripts/lib/utils/bootstrap_linked_tabs.js
@@ -1,12 +1,12 @@
 import $ from 'jquery';
 
 /**
- * Linked Tabs
+ * @class LinkedTabs
  *
  * Handles persisting and restores the current tab selection and content.
  * Reusable component for static content.
  *
- * ### Example Markup
+ * @example
  *
  *  <ul class="nav-links tab-links">
  *    <li class="active">
@@ -30,9 +30,6 @@ import $ from 'jquery';
  *    </div>
  * </div>
  *
- *
- * ### How to use
- *
  *  new LinkedTabs({
  *    action: "#{controller.action_name}",
  *    defaultAction: 'tab1',
diff --git a/app/assets/javascripts/lib/utils/common_utils.js b/app/assets/javascripts/lib/utils/common_utils.js
index 040d0bc659e..c262ae2d8e5 100644
--- a/app/assets/javascripts/lib/utils/common_utils.js
+++ b/app/assets/javascripts/lib/utils/common_utils.js
@@ -1,3 +1,7 @@
+/**
+ * @module common-utils
+ */
+
 import $ from 'jquery';
 import axios from './axios_utils';
 import { getLocationHash } from './url_utility';
@@ -445,10 +449,16 @@ export const convertPermissionToBoolean = permission => {
 };
 
 /**
+ * @callback backOffCallback
+ * @param {Function} next
+ * @param {Function} stop
+ */
+
+/**
  * Back Off exponential algorithm
  * backOff :: (Function<next, stop>, Number) -> Promise<Any, Error>
  *
- * @param {Function<next, stop>} fn function to be called
+ * @param {backOffCallback} fn function to be called
  * @param {Number} timeout
  * @return {Promise<Any, Error>}
  * @example
diff --git a/app/assets/javascripts/lib/utils/datetime_utility.js b/app/assets/javascripts/lib/utils/datetime_utility.js
index 59007d5950e..f68998189b4 100644
--- a/app/assets/javascripts/lib/utils/datetime_utility.js
+++ b/app/assets/javascripts/lib/utils/datetime_utility.js
@@ -1,3 +1,7 @@
+/**
+ * @module datetime utils
+ */
+
 import $ from 'jquery';
 import _ from 'underscore';
 import timeago from 'timeago.js';
diff --git a/app/assets/javascripts/lib/utils/number_utils.js b/app/assets/javascripts/lib/utils/number_utils.js
index 2ccc51c35f7..d4aec556984 100644
--- a/app/assets/javascripts/lib/utils/number_utils.js
+++ b/app/assets/javascripts/lib/utils/number_utils.js
@@ -1,3 +1,7 @@
+/**
+ * @module number utils
+ */
+
 import { BYTES_IN_KIB } from './constants';
 
 /**
diff --git a/app/assets/javascripts/lib/utils/text_utility.js b/app/assets/javascripts/lib/utils/text_utility.js
index 7cc7cd6d20e..ff8439dc7c2 100644
--- a/app/assets/javascripts/lib/utils/text_utility.js
+++ b/app/assets/javascripts/lib/utils/text_utility.js
@@ -1,4 +1,8 @@
 /**
+ * @module text utils
+ */
+
+/**
  * Adds a , to a string composed by numbers, at every 3 chars.
  *
  * 2333 -> 2,333
diff --git a/app/assets/javascripts/lib/utils/tick_formats.js b/app/assets/javascripts/lib/utils/tick_formats.js
index af3ca714400..24c21943126 100644
--- a/app/assets/javascripts/lib/utils/tick_formats.js
+++ b/app/assets/javascripts/lib/utils/tick_formats.js
@@ -1,3 +1,7 @@
+/**
+ * @module tick formats
+ */
+
 import { createDateTimeFormat } from '../../locale';
 
 let dateTimeFormats;
diff --git a/app/assets/javascripts/locale/index.js b/app/assets/javascripts/locale/index.js
index 1ae3362c4bc..50a2ca27b3e 100644
--- a/app/assets/javascripts/locale/index.js
+++ b/app/assets/javascripts/locale/index.js
@@ -1,3 +1,7 @@
+/**
+ * @module locale
+ */
+
 import Jed from 'jed';
 import ensureSingleLine from './ensure_single_line';
 import sprintf from './sprintf';
diff --git a/app/assets/javascripts/locale/sprintf.js b/app/assets/javascripts/locale/sprintf.js
index 5246c49842e..68b64a3a16a 100644
--- a/app/assets/javascripts/locale/sprintf.js
+++ b/app/assets/javascripts/locale/sprintf.js
@@ -4,8 +4,8 @@ import _ from 'underscore';
   Very limited implementation of sprintf supporting only named parameters.
 
   @param input (translated) text with parameters (e.g. '%{num_users} users use us')
-  @param parameters object mapping parameter names to values (e.g. { num_users: 5 })
-  @param escapeParameters whether parameter values should be escaped (see http://underscorejs.org/#escape)
+  @param {Object} parameters object mapping parameter names to values (e.g. { num_users: 5 })
+  @param {Boolean} escapeParameters whether parameter values should be escaped (see http://underscorejs.org/#escape)
   @returns {String} the text with parameters replaces (e.g. '5 users use us')
 
   @see https://ruby-doc.org/core-2.3.3/Kernel.html#method-i-sprintf
diff --git a/app/assets/javascripts/notes.js b/app/assets/javascripts/notes.js
index dfb53c986fc..23d8ed5b3a5 100644
--- a/app/assets/javascripts/notes.js
+++ b/app/assets/javascripts/notes.js
@@ -4,6 +4,10 @@ prefer-template, consistent-return, no-alert, no-return-assign,
 no-param-reassign, prefer-arrow-callback, no-else-return, vars-on-top,
 no-unused-vars, no-shadow, no-useless-escape, class-methods-use-this */
 
+/**
+ * @module Notes
+ */
+
 /* global ResolveService */
 /* global mrRefreshWidgetUrl */
 
diff --git a/app/assets/javascripts/reports/store/actions.js b/app/assets/javascripts/reports/store/actions.js
index db8ab5ccb80..de73fd2fc47 100644
--- a/app/assets/javascripts/reports/store/actions.js
+++ b/app/assets/javascripts/reports/store/actions.js
@@ -1,3 +1,7 @@
+/**
+ * @module Reports store actions
+ */
+
 import Visibility from 'visibilityjs';
 import $ from 'jquery';
 import axios from '../../lib/utils/axios_utils';