diff options
Diffstat (limited to 'app/assets/javascripts/lib/utils')
7 files changed, 33 insertions, 6 deletions
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; |