fix: api docs site build fails due to broken links

Author: abose

docs/API-Reference/widgets/NotificationUI.md

@@ -42,7 +42,7 @@ notification1.done((closeReason)=>{
     console.log("notification is closed in ui reason:", closeReason);
 })
 ```
-The [createFromTemplate](1) API can be configured with numerous options. See API options below.
+The `createFromTemplate` API can be configured with numerous options. See API options below.
 
 * [widgets/NotificationUI](#module_widgets/NotificationUI)
     * [.API](#module_widgets/NotificationUI..API)

docs/API-Reference/worker/IndexingWorker.md

@@ -9,13 +9,10 @@ brackets.getModule("worker/IndexingWorker")
 Phoenix houses a file indexing worker which caches all cacheable files of a project in memory.
 This module can be used to communicate with the Index and extend it by attaching new js worker scripts to the
 indexing worker as discussed below. Any extension that works on a large number of files should use the indexing
-worker cache to free up the main thread of heavy file access. This is similar to
-[worker/ExtensionsWorker](ExtensionsWorker-API) but with a full file index.
+worker cache to free up the main thread of heavy file access.
 
-* Extensions are advised to use [worker/ExtensionsWorker](ExtensionsWorker-API) if they do not use the file index and
-  just want to offload minor tasks.
 * Extensions performing large compute tasks should create their own worker and may use easy util methods in
-  [worker/WorkerComm](WorkerComm-API) to communicate with the web worker.
+  [worker/WorkerComm](../WorkerComm) to communicate with the web worker.
 
 ## Import
 
@@ -43,7 +40,7 @@ IndexingWorker.loadScriptInWorker(workerPath);
 Once the worker script is loaded with the above step:
 * Phoenix can communicate with worker using the `IndexingWorker` reference in Phoenix.
 * Worker can communicate with Phoenix with the global `WorkerComm` reference within the Indexing worker.
-All utility methods in module [worker/WorkerComm](WorkerComm-API) can be used for worker communication.
+All utility methods in module [worker/WorkerComm](../WorkerComm) can be used for worker communication.
 
 A global constant `Phoenix.baseURL` is available in the worker context to get the base url from which phoenix was
 launched.
@@ -52,34 +49,37 @@ NB: You can use all util methods available in `worker/WorkerComm` as `IndexingWo
 to communicate with the underlying worker thread.
 
 * [worker/IndexingWorker](#module_worker/IndexingWorker)
-    * [.WorkerComm-APIS](#module_worker/IndexingWorker..WorkerComm-APIS)
+    * [.WorkerComm](#module_worker/IndexingWorker..WorkerComm)
     * ["EVENT_CRAWL_STARTED"](#event_EVENT_CRAWL_STARTED)
     * ["EVENT_CRAWL_PROGRESS"](#event_EVENT_CRAWL_PROGRESS)
     * ["EVENT_CRAWL_COMPLETE"](#event_EVENT_CRAWL_COMPLETE)
 
-<a name="module_worker/IndexingWorker..WorkerComm-APIS"></a>
+<a name="module_worker/IndexingWorker..WorkerComm"></a>
 
-### worker/IndexingWorker.WorkerComm-APIS
+### worker/IndexingWorker.WorkerComm
 To communicate between the IndexingWorker and Phoenix, the following methods are available:
 `loadScriptInWorker`, `execPeer`, `setExecHandler`, `triggerPeer` and other APIs described
 in module `worker/WorkerComm`.
 The above methods can be used with either `IndexingWorker` reference within Phoenix
 or the global `WorkerComm` reference within the Indexing worker. (See example below.)
 
-See [worker/WorkerComm](WorkerComm-API) for detailed API docs.
+See [worker/WorkerComm](../WorkerComm) for detailed API docs.
+
+```js
+// To Execute a named function `extensionName.sayHello` in the worker from phoenix
 
-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.
-```js
+
 WorkerComm.setExecHandler("extensionName.sayHello", (arg)=>{
     console.log("hello from worker ", arg); // prints "hello from worker phoenix"
     return "Hello Phoenix";
 });
-```
+
 // In Phoenix/extension
 let workerMessage = await IndexingWorker.execPeer("extensionName.sayHello", "phoenix");
 console.log(workerMessage); // prints "Hello Phoenix"
+```
 
 **Kind**: inner property of [<code>worker/IndexingWorker</code>](#module_worker/IndexingWorker)  
 <a name="event_EVENT_CRAWL_STARTED"></a>

src/widgets/NotificationUI.js

@@ -57,7 +57,7 @@
  *     console.log("notification is closed in ui reason:", closeReason);
  * })
  * ```
- * The [createFromTemplate](1) API can be configured with numerous options. See API options below.
+ * The `createFromTemplate` API can be configured with numerous options. See API options below.
  * @module widgets/NotificationUI
  */
 

src/worker/IndexingWorker.js

@@ -18,19 +18,15 @@
  *
  */
 
-/*global Phoenix*/
 // @INCLUDE_IN_API_DOCS
 /**
  * Phoenix houses a file indexing worker which caches all cacheable files of a project in memory.
  * This module can be used to communicate with the Index and extend it by attaching new js worker scripts to the
  * indexing worker as discussed below. Any extension that works on a large number of files should use the indexing
- * worker cache to free up the main thread of heavy file access. This is similar to
- * [worker/ExtensionsWorker](ExtensionsWorker-API) but with a full file index.
+ * worker cache to free up the main thread of heavy file access.
  *
- * * Extensions are advised to use [worker/ExtensionsWorker](ExtensionsWorker-API) if they do not use the file index and
- *   just want to offload minor tasks.
  * * Extensions performing large compute tasks should create their own worker and may use easy util methods in
- *   [worker/WorkerComm](WorkerComm-API) to communicate with the web worker.
+ *   [worker/WorkerComm](../WorkerComm) to communicate with the web worker.
  *
  * ## Import
  * @example
@@ -57,7 +53,7 @@
  * Once the worker script is loaded with the above step:
  * * Phoenix can communicate with worker using the `IndexingWorker` reference in Phoenix.
  * * Worker can communicate with Phoenix with the global `WorkerComm` reference within the Indexing worker.
- * All utility methods in module [worker/WorkerComm](WorkerComm-API) can be used for worker communication.
+ * All utility methods in module [worker/WorkerComm](../WorkerComm) can be used for worker communication.
  *
  * A global constant `Phoenix.baseURL` is available in the worker context to get the base url from which phoenix was
  * launched.
@@ -91,21 +87,24 @@ define(function (require, exports, module) {
      * The above methods can be used with either `IndexingWorker` reference within Phoenix
      * or the global `WorkerComm` reference within the Indexing worker. (See example below.)
      *
-     * See [worker/WorkerComm](WorkerComm-API) for detailed API docs.
+     * See [worker/WorkerComm](../WorkerComm) for detailed API docs.
+     *
+     * ```js
+     * // To Execute a named function `extensionName.sayHello` in the worker from phoenix
      *
-     * 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.
-     * ```js
+     *
      * WorkerComm.setExecHandler("extensionName.sayHello", (arg)=>{
      *     console.log("hello from worker ", arg); // prints "hello from worker phoenix"
      *     return "Hello Phoenix";
      * });
-     * ```
+     *
      * // In Phoenix/extension
      * let workerMessage = await IndexingWorker.execPeer("extensionName.sayHello", "phoenix");
      * console.log(workerMessage); // prints "Hello Phoenix"
-     * @name WorkerComm-APIS
+     * ```
+     * @name WorkerComm
      */
 
     /**