summaryrefslogtreecommitdiff
path: root/app/assets/javascripts/ide/index.js
diff options
context:
space:
mode:
authorWinnie Hellmann <winnie@gitlab.com>2018-12-05 11:49:53 +0100
committerWinnie Hellmann <winnie@gitlab.com>2018-12-05 11:49:53 +0100
commit718479b527e917344a880450fe5781b407d80b80 (patch)
treecbb7065ec3b5e88fc129a620a85aeb5a43df4cef /app/assets/javascripts/ide/index.js
parent0515ace283e4892da437831692b2bb8b073eb0fc (diff)
downloadgitlab-ce-718479b527e917344a880450fe5781b407d80b80.tar.gz
Fix some stuffwinh-jsdoc
Diffstat (limited to 'app/assets/javascripts/ide/index.js')
-rw-r--r--app/assets/javascripts/ide/index.js11
1 files changed, 9 insertions, 2 deletions
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.
*/