diff options
author | Winnie Hellmann <winnie@gitlab.com> | 2019-01-14 21:46:21 +0000 |
---|---|---|
committer | Clement Ho <clemmakesapps@gmail.com> | 2019-01-14 21:46:21 +0000 |
commit | 7999ca32241e785df539fc0d3a354f97bc2266a0 (patch) | |
tree | 01d46a35ab2ebaac758a5f8a6b7924be83cbf8ad /app/assets/javascripts/ide/index.js | |
parent | 3de1b521b7502adf380a241b2136d9cd0c17c4e3 (diff) | |
download | gitlab-ce-7999ca32241e785df539fc0d3a354f97bc2266a0.tar.gz |
Generate searchable JSDoc documentation
Diffstat (limited to 'app/assets/javascripts/ide/index.js')
-rw-r--r-- | app/assets/javascripts/ide/index.js | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/app/assets/javascripts/ide/index.js b/app/assets/javascripts/ide/index.js index 6351948f750..5a2b680c2f7 100644 --- a/app/assets/javascripts/ide/index.js +++ b/app/assets/javascripts/ide/index.js @@ -10,13 +10,20 @@ import { parseBoolean } from '../lib/utils/common_utils'; Vue.use(Translate); /** + * Function that receives the default store and returns an extended one. + * @callback extendStoreCallback + * @param {Vuex.Store} store + * @param {Element} el + */ + +/** * 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 {Component} options.rootComponent - * Component that overrides the root component. - * @param {(store:Vuex.Store, el:Element) => Vuex.Store} options.extendStore - + * @param {extendStoreCallback} options.extendStore - * Function that receives the default store and returns an extended one. */ export function initIde(el, options = {}) { |