docs: remove old generated docs and move to new framework

Author: abose

…cs/generatedApiDocs/NodeConnector-API.md docs/API-Reference/NodeConnector.mddocs/generatedApiDocs/NodeConnector-API.md renamed to docs/API-Reference/NodeConnector.md docs/generatedApiDocs/NodeConnector-API.md renamed to docs/API-Reference/NodeConnector.md

@@ -1,7 +1,11 @@
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+### Import :
+```js
+brackets.getModule("NodeConnector")
+```
 
-## NodeConnector
+<a name="module_NodeConnector"></a>
 
+## NodeConnector
 Node Connector Communication Module
 
 This module simplifies communication between Node.js and Phoenix (phcode). A `NodeConnector` acts as an intermediary,
@@ -15,28 +19,29 @@ To establish communication between two modules, such as `x.js` in Phoenix and `y
 
 ### Create `NodeConnector` in Phoenix (`x.js`)
 
+**Example**  
 ```js
 const NodeConnector = require('NodeConnector');
 const XY_NODE_CONNECTOR_ID = 'ext_x_y'; // Use a unique ID
 let nodeConnector = NodeConnector.createNodeConnector(XY_NODE_CONNECTOR_ID, exports);
 
-exports.modifyImage = async function(imageName, imageArrayBuffer) \{
+exports.modifyImage = async function(imageName, imageArrayBuffer) {
   // Perform image operations with the imageArrayBuffer
   // To return an ArrayBuffer, return an object with a `buffer` key.
-  return \{
+  return {
     operationDone: 'colored, cropped',
     buffer: imageArrayBuffer,
   };
 };
 ```
 
 ### Create `NodeConnector` in Node.js (`y.js`)
-
+**Example**  
 ```js
 const XY_NODE_CONNECTOR_ID = 'ext_x_y'; // Use the same unique ID
 let nodeConnector = global.createNodeConnector(XY_NODE_CONNECTOR_ID, exports);
 
-exports.getPWDRelative = async function(subPath) \{
+exports.getPWDRelative = async function(subPath) {
   return process.cwd + '/' + subPath;
 };
 ```
@@ -46,44 +51,44 @@ With these steps, a `NodeConnector` is set up, enabling two-way communication.
 ## Executing Functions
 
 To call a Node.js function from Phoenix, use the `execPeer` method.
-
+**Example**  
 ```js
 // In `x.js` (Phoenix)
 const fullPath = await nodeConnector.execPeer('getPWDRelative', 'sub/path.html');
 ```
 
 To execute a Phoenix function from Node.js and transfer binary data, pass an optional ArrayBuffer.
-
+**Example**  
 ```js
 // In `y.js` (Node.js)
-const \{ operationDone, buffer } = await nodeConnector.execPeer('modifyImage', \{name:'theHills.png'}, imageAsArrayBuffer);
+const { operationDone, buffer } = await nodeConnector.execPeer('modifyImage', {name:'theHills.png'}, imageAsArrayBuffer);
 ```
 
 ## Event Handling
 
 The `NodeConnector` object implements all the APIs supported by `utils/EventDispatcher`. You can trigger and listen
 to events between Node.js and Phoenix using the `triggerPeer` and (`on`, `one` or `off`) methods.
-
+**Example**  
 ```js
 // In `y.js` (Node.js)
-nodeConnector.on('phoenixProjectOpened', (_event, projectPath) => \{
+nodeConnector.on('phoenixProjectOpened', (_event, projectPath) => {
   console.log(projectPath);
 });
 
-nodeConnector.one('phoenixProjectOpened', (_event, projectPath) => \{
+nodeConnector.one('phoenixProjectOpened', (_event, projectPath) => {
   console.log(projectPath + "will be received only once");
 });
 ```
 
 To raise an event from Phoenix to Node.js:
-
+**Example**  
 ```js
 // In `x.js` (Phoenix)
 nodeConnector.triggerPeer('phoenixProjectOpened', '/x/project/folder');
 ```
 
 To Switch off events
-
+**Example**  
 ```js
 nodeConnector.off('phoenixProjectOpened'); // will switch off all event handlers of that name.
 ```
@@ -97,37 +102,43 @@ When executing functions that send or receive binary data, ensure that the funct
 optional ArrayBuffer as a parameter. To return binary data, use an object with a `buffer` key.
 
 Example of calling a function in Node.js with binary data transfer:
-
+**Example**  
 ```js
 // In `y.js` (Node.js)
-const \{ operationDone, buffer } = await nodeConnector.execPeer('modifyImage', \{name:'name.png'}, imageArrayBuffer);
+const { operationDone, buffer } = await nodeConnector.execPeer('modifyImage', {name:'name.png'}, imageArrayBuffer);
 ```
 
 ### Handling ArrayBuffer Data in Event Handling
 
 Use the `triggerPeer` method to send binary data in events. Include the ArrayBuffer as an optional parameter.
 
 Example of sending binary data in an event from Phoenix to Node.js:
-
+**Example**  
 ```js
 // In `x.js` (Phoenix)
 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
-    second argument can be used to transfer large binary data as an ArrayBuffer.
+## 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
+  second argument can be used to transfer large binary data as an ArrayBuffer.
 
 For more event handling operations and details, refer to the documentation for the `utils/EventDispatcher` module.
 
-## createNodeConnector
+* [NodeConnector](#module_NodeConnector)
+    * [.createNodeConnector(nodeConnectorID, moduleExports)](#module_NodeConnector..createNodeConnector) ⇒ <code>Object</code>
+    * [.isNodeAvailable()](#module_NodeConnector..isNodeAvailable) ⇒ <code>boolean</code>
+    * [.isNodeReady()](#module_NodeConnector..isNodeReady) ⇒ <code>boolean</code>
+    * [.terminateNode()](#module_NodeConnector..terminateNode) ⇒ <code>Promise</code>
+    * [.setInspectEnabled(enabled)](#module_NodeConnector..setInspectEnabled)
+    * [.isInspectEnabled()](#module_NodeConnector..isInspectEnabled) ⇒ <code>boolean</code>
+    * [.getInspectPort()](#module_NodeConnector..getInspectPort) ⇒ <code>number</code>
+
+<a name="module_NodeConnector..createNodeConnector"></a>
 
+### NodeConnector.createNodeConnector(nodeConnectorID, moduleExports) ⇒ <code>Object</code>
 Creates a new node connector with the specified ID and module exports.
 
 Returns a NodeConnector Object (which is an EventDispatcher with
@@ -142,69 +153,64 @@ If the connector is not created within this timeout period, all queued `execPeer
 and all queued events will be dropped. It is recommended to call the `createNodeConnector` API on both ends
 within a timeframe of less than 10 seconds(ideally same time) for seamless communication.
 
-*   execPeer: A function that executes a peer function with specified parameters.
-*   triggerPeer: A function that triggers an event to be sent to a peer.
-*   Also contains all the APIs supported by `utils/EventDispatcher` module.
+- execPeer: A function that executes a peer function with specified parameters.
+- triggerPeer: A function that triggers an event to be sent to a peer.
+- Also contains all the APIs supported by `utils/EventDispatcher` module.
 
-### Parameters
+**Kind**: inner method of [<code>NodeConnector</code>](#module_NodeConnector)  
+**Returns**: <code>Object</code> - - A NodeConnector Object. Also contains all the APIs supported by `utils/EventDispatcher` module.  
+**Throws**:
 
-*   `nodeConnectorID` **[string][1]** The unique identifier for the new node connector.
-*   `moduleExports` **[Object][2]** The exports of the module that contains the functions to be executed on the other side.
+- <code>Error</code> - If a node connector with the same ID already exists/invalid args passed.
 
-<!---->
 
-*   Throws **[Error][3]** If a node connector with the same ID already exists/invalid args passed.
+| Param | Type | Description |
+| --- | --- | --- |
+| nodeConnectorID | <code>string</code> | The unique identifier for the new node connector. |
+| moduleExports | <code>Object</code> | The exports of the module that contains the functions to be executed on the other side. |
 
-Returns **\{execPeer: [function][4], triggerPeer: [function][4], trigger: [function][4], on: [function][4], off: [function][4], one: [function][4]}** A NodeConnector Object. Also contains all the APIs supported by `utils/EventDispatcher` module.
-
-## isNodeAvailable
+<a name="module_NodeConnector..isNodeAvailable"></a>
 
+### NodeConnector.isNodeAvailable() ⇒ <code>boolean</code>
 Checks if Node.js Engine is available. (returns true even if the node instance is terminated)
 
-Returns **[boolean][5]** Returns true if Node.js Engine is available.
-
-## isNodeReady
+**Kind**: inner method of [<code>NodeConnector</code>](#module_NodeConnector)  
+**Returns**: <code>boolean</code> - Returns true if Node.js Engine is available.  
+<a name="module_NodeConnector..isNodeReady"></a>
 
+### NodeConnector.isNodeReady() ⇒ <code>boolean</code>
 Node is available and is ready to exec requests
 
-Returns **[boolean][5]** 
-
-## terminateNode
+**Kind**: inner method of [<code>NodeConnector</code>](#module_NodeConnector)  
+<a name="module_NodeConnector..terminateNode"></a>
 
+### NodeConnector.terminateNode() ⇒ <code>Promise</code>
 Terminate the PhNodeEngine node if it is available. Else does nothing.
 
-Returns **[Promise][6]** promise that resolves when node process is terminated and exits.
-
-## setInspectEnabled
+**Kind**: inner method of [<code>NodeConnector</code>](#module_NodeConnector)  
+**Returns**: <code>Promise</code> - promise that resolves when node process is terminated and exits.  
+<a name="module_NodeConnector..setInspectEnabled"></a>
 
+### NodeConnector.setInspectEnabled(enabled)
 Sets weather to enable node inspector in next boot.
 
-### Parameters
+**Kind**: inner method of [<code>NodeConnector</code>](#module_NodeConnector)  
 
-*   `enabled` **[boolean][5]** true to enable, else false.
+| Param | Type | Description |
+| --- | --- | --- |
+| enabled | <code>boolean</code> | true to enable, else false. |
 
-## isInspectEnabled
+<a name="module_NodeConnector..isInspectEnabled"></a>
 
+### NodeConnector.isInspectEnabled() ⇒ <code>boolean</code>
 Returns whether node inspector is enabled. If node is not present, always returns false.
 
-Returns **[boolean][5]** True if inspect mode is enabled, false otherwise.
-
-## getInspectPort
+**Kind**: inner method of [<code>NodeConnector</code>](#module_NodeConnector)  
+**Returns**: <code>boolean</code> - True if inspect mode is enabled, false otherwise.  
+<a name="module_NodeConnector..getInspectPort"></a>
 
+### NodeConnector.getInspectPort() ⇒ <code>number</code>
 Retrieves the node inspector port for the Phoenix Node.js engine.
 
-Returns **[number][7]** The inspection port number.
-
-[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
-
-[2]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
-
-[3]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error
-
-[4]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function
-
-[5]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
-
-[6]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
-
-[7]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+**Kind**: inner method of [<code>NodeConnector</code>](#module_NodeConnector)  
+**Returns**: <code>number</code> - The inspection port number.