fix: js files to make it docusaurus compatible

Author: devvaannsh

src/features/QuickViewManager.js

@@ -262,19 +262,17 @@ define(function (require, exports, module) {
      * 3. If non-null, but visible==false, we're waiting for HOVER_DELAY, which
      *    is tracked by hoverTimer. The state changes to visible==true as soon as
      *    there is a provider. If the mouse moves before then, timer is restarted.
-     *
-     * @type {{
-     *      visible: boolean,
-     *      editor: !Editor,
-     *      hoverTimer: number,             - setTimeout() token
-     *      start: !{line, ch},             - start of matched text range
-     *      end: !{line, ch},               - end of matched text range
-     *      content: !string,               - HTML content to display in popover
-     *      xpos: number,                   - x of center of popover
-     *      ytop: number,                   - y of top of matched text (when popover placed above text, normally)
-     *      ybot: number,                   - y of bottom of matched text (when popover moved below text, avoiding window top)
-     *      marker: ?CodeMirror.TextMarker  - only set once visible==true
-     * }}
+     * @typedef {Object} PopoverState
+     * @property {boolean} visible - Whether the popover is visible.
+     * @property {!Editor} editor - The editor instance associated with the popover.
+     * @property {number} hoverTimer - The token returned by setTimeout().
+     * @property {!{line: number, ch: number}} start - Start of the matched text range.
+     * @property {!{line: number, ch: number}} end - End of the matched text range.
+     * @property {!string} content - HTML content to display in the popover.
+     * @property {number} xpos - X-coordinate of the center of the popover.
+     * @property {number} ytop - Y-coordinate of the top of the matched text when popover is above the text.
+     * @property {number} ybot - Y-coordinate of the bottom of the matched text when popover is below the text.
+     * @property {?CodeMirror.TextMarker} marker - The text marker; only set once `visible` is `true`.
      * @private
      */
     let popoverState = null;
@@ -413,7 +411,7 @@ define(function (require, exports, module) {
      * Returns a popover array with the list of popovers to be rendered after filtering from providers.
      * @param results
      * @param providerInfos
-     * @return {*[]}
+     * @return []
      * @private
      */
     function _getPopover(results, providerInfos) {

src/features/SelectionViewManager.js

@@ -218,17 +218,15 @@ define(function (require, exports, module) {
      * 3. If non-null, but visible==false, we're waiting for HOVER_DELAY, which
      *    is tracked by hoverTimer. The state changes to visible==true as soon as
      *    there is a provider. If the mouse moves before then, timer is restarted.
-     *
-     * @type {{
-     *      visible: boolean,
-     *      editor: !Editor,
-     *      start: !{line, ch},             - start of matched text range
-     *      end: !{line, ch},               - end of matched text range
-     *      content: !string,               - HTML content to display in popover
-     *      xpos: number,                   - x of center of popover
-     *      ytop: number,                   - y of top of matched text (when popover placed above text, normally)
-     *      ybot: number,                   - y of bottom of matched text (when popover moved below text, avoiding window top)
-     * }}
+     * @typedef {Object} PopoverState
+     * @property {boolean} visible - Whether the popover is visible.
+     * @property {!Editor} editor - The editor instance associated with the popover.
+     * @property {!{line: number, ch: number}} start - Start of the matched text range.
+     * @property {!{line: number, ch: number}} end - End of the matched text range.
+     * @property {!string} content - HTML content to display in the popover.
+     * @property {number} xpos - X-coordinate of the center of the popover.
+     * @property {number} ytop - Y-coordinate of the top of the matched text when the popover is placed above the text.
+     * @property {number} ybot - Y-coordinate of the bottom of the matched text when the popover is moved below the text.
      * @private
      */
     let popoverState = null;

src/utils/EventManager.js

@@ -144,12 +144,12 @@ define(function (require, exports, module) {
      * // and not available for use in extensions.
      * window.Phoenix.TRUSTED_ORIGINS ["http://mydomain.com"] = true;
      * EventManager.registerEventHandler("`extensionName`-iframeMessageHandler", exports);
-     * exports.on("iframeHelloEvent", function(_ev, event){
+     * exports.on("iframeHelloEvent", function(_ev, event)\{
      *    console.log(event.data.message);
      * });
      *
      * // Now from your iframe, send a message to the above event handler using:
-     * window.parent.postMessage({
+     * window.parent.postMessage(\{
      *     handlerName: "`extensionName`-iframeMessageHandler",
      *     eventName: "iframeHelloEvent",
      *     message: "hello world"

src/utils/ExtensionInterface.js

@@ -49,7 +49,7 @@
  * let angularCli;
  * ExtensionInterface.waitAndGetExtensionInterface("angularCli").then(interfaceObj=> angularCli = interfaceObj);
  * ...
- * if(angularCli){ // check if angular cli is avilable
+ * if(angularCli)\{ // check if angular cli is avilable
  * angularCli.callSomeFunction();
  * }
  * ...
@@ -108,7 +108,7 @@ define(function (require, exports, module) {
      * let angularCli;
      * ExtensionInterface.waitAndGetExtensionInterface("angularCli").then(interfaceObj=> angularCli = interfaceObj);
      * ...
-     * if(angularCli){ // check if angular cli is avilable
+     * if(angularCli)\{ // check if angular cli is avilable
      * angularCli.callSomeFunction();
      * }
      * ...

src/utils/FeatureGate.js

@@ -89,7 +89,7 @@ define(function (require, exports, module) {
 
     /**
      * Returns an array of all named registered feature gates.
-     * @return {[String]} list of registered features
+     * @return [] list of registered features
      * @type {function}
      */
     function getAllRegisteredFeatures() {

src/utils/StringUtils.js

@@ -44,7 +44,7 @@ define(function (require, exports, module) {
      * Example: var formatted = StringUtils.format("Hello {0}", "World");
      *
      * @param {string} str The base string
-     * @param {...} Arguments to be substituted into the string
+     * @param {rest} Arguments to be substituted into the string
      *
      * @return {string} Formatted string
      */

src/widgets/NotificationUI.js

@@ -180,7 +180,7 @@ define(function (require, exports, module) {
      * // note that you can even provide an HTML Element node with
      * // custom event handlers directly here instead of HTML text.
      * let notification1 = NotificationUI.createFromTemplate(
-     *   "<div>Click me to locate the file in file tree</div>", "showInfileTree",{
+     *   "<div>Click me to locate the file in file tree</div>", "showInfileTree",\{
      *       allowedPlacements: ['top', 'bottom'],
      *       dismissOnClick: false,
      *       autoCloseTimeS: 300 // auto close the popup after 5 minutes
@@ -307,7 +307,7 @@ define(function (require, exports, module) {
      * // note that you can even provide an HTML Element node with
      * // custom event handlers directly here instead of HTML text.
      * let notification1 = NotificationUI.createToastFromTemplate( "Title here",
-     *   "<div>Click me to locate the file in file tree</div>", {
+     *   "<div>Click me to locate the file in file tree</div>", \{
      *       dismissOnClick: false,
      *       autoCloseTimeS: 300 // auto close the popup after 5 minutes
      *   });

src/worker/IndexingWorker.js

@@ -96,7 +96,7 @@ define(function (require, exports, module) {
      * To Execute a named function `extensionName.sayHello` in the worker from phoenix
      * // in my_worker.js. It is a good practice to prefix your `[extensionName]`
      * // to exec handler to prevent name collisions with other extensions.
-     * WorkerComm.setExecHandler("extensionName.sayHello", (arg)=>{
+     * WorkerComm.setExecHandler("extensionName.sayHello", (arg)=>\{
      *     console.log("hello from worker ", arg); // prints "hello from worker phoenix"
      *     return "Hello Phoenix";
      *   });