Fix JSdoc issues causing formatting issue in docs site

Author: devvaannsh

src/NodeConnector.js

@@ -133,9 +133,7 @@
  * const imageArrayBuffer = getSomeImageArrayBuffer(); // Get the ArrayBuffer
  * nodeConnector.triggerPeer('imageEdited', 'name.png', imageArrayBuffer);
  * ```
- *
  * * ## Caveats
- *
  * - Be cautious when sending large binary data, as it may affect performance and memory usage. Transferring large
  *   data is fully supported, but be mindful of performance.
  * - Functions called with `execPeer` and `triggerPeer` must be asynchronous and accept a single argument. An optional

src/features/NewFileContentManager.js

@@ -127,7 +127,7 @@ define(function (require, exports, module) {
     /**
      * Returns a promise that resolves to the default text content of the given file after querying
      * all the content providers. If no text is returned by any providers, it will return an empty string "".
-     * @example <caption>To get the default content given a path</caption>
+     * To get the default content given a path
      * NewFileContentManager.getInitialContentForFile("/path/to/file.jsx");
      * @param {string} fullPath
      * @returns {Promise<string>} The text contents

src/utils/EventManager.js

@@ -56,7 +56,7 @@ define(function (require, exports, module) {
      * Registers a named EventHandler. Event handlers are created using the call:
      * `EventDispatcher.makeEventDispatcher(Command.prototype);`
      *
-     * @example <caption>To register a close dialogue event handler in an extension:</caption>
+     * To register a close dialogue event handler in an extension:
      * // in close-dialogue.js module winthin the extension, do the following:
      * const EventDispatcher = brackets.getModule("utils/EventDispatcher"),
      * EventDispatcher.makeEventDispatcher(exports);
@@ -93,7 +93,7 @@ define(function (require, exports, module) {
     /**
      * Triggers an event on the named event handler.
      *
-     * @example <caption>To trigger an event to the `closeDialogue` event handler registered above</caption>
+     * To trigger an event to the `closeDialogue` event handler registered above
      * // anywhere in code, do the following:
      * const EventManager = brackets.getModule("utils/EventManager");
      * EventManager.triggerEvent("closeDialogueHandler", "someEvent", "param1", "param2", ...);

src/utils/ExtensionInterface.js

@@ -76,7 +76,7 @@ define(function (require, exports, module) {
     /**
      * Registers a named extension interface. Will overwrite if an interface of the same name is already present.
      *
-     * @example <caption>To register an interface `angularCli`</caption>
+     * To register an interface `angularCli`
      * ExtensionInterface.registerExtensionInterface("angularCli", exports);
      *
      * @param {string} extensionInterfaceName
@@ -102,7 +102,7 @@ define(function (require, exports, module) {
      * Returns a promise that gets resolved only when an ExtensionInterface of the given name is registered. Use this
      * getter to get hold of extensions interface predictably.
      *
-     * @example <caption>To get a registered interface `angularCli`</caption>
+     * To get a registered interface `angularCli`
      * let angularCli;
      * ExtensionInterface.waitAndGetExtensionInterface("angularCli").then(interfaceObj=> angularCli = interfaceObj);
      * ...

src/utils/FeatureGate.js

@@ -68,7 +68,7 @@ define(function (require, exports, module) {
 
     /**
      * Registers a named feature with the default enabled state.
-     * @example <caption>To register a feature gate with name `myExtension.newColors`</caption>
+     * To register a feature gate with name `myExtension.newColors`
      * const FEATURE_NEW_COLORS = 'myExtension.newColors';
      * FeatureGate.registerFeatureGate(FEATURE_NEW_COLORS, false); // false is the default value here
      *
@@ -96,7 +96,7 @@ define(function (require, exports, module) {
 
     /**
      * Returns true is an featureGate is enabled either by default or overridden by the user using local storage.
-     * @example <caption>To check if the feature `myExtension.newColors` is enabled</caption>
+     * To check if the feature `myExtension.newColors` is enabled
      * const FEATURE_NEW_COLORS = 'myExtension.newColors';
      * if(FeatureGate.isFeatureEnabled(FEATURE_NEW_COLORS)){
      *    // do fancy colors here

src/utils/Metrics.js

@@ -335,7 +335,7 @@ define(function (require, exports, module) {
 
     /**
      * log a numeric count >=0
-     * @example <caption>To log that user clicked searchButton 5 times:</caption>
+     * To log that user clicked searchButton 5 times:
      * Metrics.countEvent(Metrics.EVENT_TYPE.UI, "searchButton", "click");
      * Metrics.countEvent(Metrics.EVENT_TYPE.UI, "searchButton", "click", 5);
      *
@@ -364,7 +364,7 @@ define(function (require, exports, module) {
 
     /**
      * log a numeric value (number).
-     * @example <caption>To log that startup time is 200ms:</caption>
+     * To log that startup time is 200ms:
      * Metrics.valueEvent(Metrics.EVENT_TYPE.PERFORMANCE, "startupTime", "ms", 200);
      *
      * @param {EVENT_TYPE|string} eventType The kind of Event Type that needs to be logged- should be a js var compatible string.

src/widgets/NotificationUI.js

@@ -159,7 +159,7 @@ define(function (require, exports, module) {
     /**
      * Adds a done callback to the Notification promise. The promise will be resolved
      * when the Notification is dismissed. Never rejected.
-     * @example <caption>Print the close reason on console when the notification closes</caption>
+     * Print the close reason on console when the notification closes
      * notificationInstance.done((closeReason)=>{
      *     console.log(closeReason)
      * })
@@ -174,7 +174,7 @@ define(function (require, exports, module) {
      * Creates a new notification popup from given template.
      * The template can either be a string or a jQuery object representing a DOM node that is *not* in the current DOM.
      *
-     * @example <caption>Creating a notification popup</caption>
+     * Creating a notification popup
      * // note that you can even provide an HTML Element node with
      * // custom event handlers directly here instead of HTML text.
      * let notification1 = NotificationUI.createFromTemplate(
@@ -301,7 +301,7 @@ define(function (require, exports, module) {
      * Creates a new toast notification popup from given title and html message.
      * The message can either be a string or a jQuery object representing a DOM node that is *not* in the current DOM.
      *
-     * @example <caption>Creating a toast notification popup</caption>
+     * Creating a toast notification popup
      * // 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",

src/worker/IndexingWorker.js

@@ -91,7 +91,7 @@ define(function (require, exports, module) {
      *
      * See [worker/WorkerComm](WorkerComm-API) for detailed API docs.
      *
-     * @example <caption>To Execute a named function `extensionName.sayHello` in the worker from phoenix</caption>
+     * 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)=>{

src/worker/WorkerComm.js

@@ -106,7 +106,7 @@
     /**
      * Adds support for WorkerComm APIs to the provided web-Worker instance. Only available in the main thread.
      * This API should be called immediately after creating the worker in main thread.
-     * @example <caption>Create a web-worker with `WorkerComm` in an extension.</caption>
+     * Create a web-worker with `WorkerComm` in an extension.
      * // load the worker [See API docs for full sample]
      * const _myWorker = new Worker(
      * `${workerPath}?workerCommUrl=${workerCommUrl}&eventDispatcherURL=${eventDispatcherURL}`);
@@ -126,7 +126,7 @@
 
         /**
          * Sets a named function execution handler in the main thread or worker thread.
-         * @example <caption>To set a named function `sayHello` in worker and phoenix</caption>
+         * To set a named function `sayHello` in worker and phoenix
          *
          * function sayHello(arg)=>{
          *     console.log("hello from worker ", arg); // prints "hello from worker phoenix"
@@ -153,7 +153,7 @@
          * Executes the named function at the other end if present. If this is called from the main thread, it will
          * execute the function at the worker thread and vice-versa. The function to execute
          * is set with API `setExecHandler`.
-         * @example <caption>To Execute a named function `sayHello` in the worker from phoenix</caption>
+         * To Execute a named function `sayHello` in the worker from phoenix
          * // in my_worker.js
          * WorkerComm.setExecHandler("sayHello", (arg)=>{
          *     console.log("hello from worker ", arg); // prints "hello from worker phoenix"
@@ -184,7 +184,7 @@
          * Triggers events at the other end on the eventDispatcher. If this is called from the main thread, it will
          * trigger `WorkerComm` global at the worker thread. If this is called from the worker thread, it will
          * trigger `eventDispatcher` used in `createWorkerComm` API call when creating the worker.
-         * @example <caption>To Trigger a named event `searchDone` from worker to phoenix</caption>
+         * To Trigger a named event `searchDone` from worker to phoenix
          * // in my_worker.js
          * WorkerComm.triggerPeer("searchDone", {matches: 2});
          *
@@ -222,7 +222,7 @@
             /**
              * Loads a script into the worker context. Only available within the main thread. This can be used
              * by the main Phoenix thread to dynamically load scripts in the worker-thread.
-             * @example <caption>To load a script `add_worker_Script.js` into the your worker:</caption>
+             * To load a script `add_worker_Script.js` into the your worker:
              * WorkerComm.createWorkerComm(_myWorker, exports);
              * .....
              * let ExtensionUtils = brackets.getModule("utils/ExtensionUtils");