Skip to content

Commit 7141ad3

Browse files
devvaannshabose
authored andcommitted
fix: broken markdown, docusaurus was unable to parse
1 parent ab95a39 commit 7141ad3

File tree

4 files changed

+15
-15
lines changed

4 files changed

+15
-15
lines changed

docs/generatedApiDocs/NodeConnector-API.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ const NodeConnector = require('NodeConnector');
2020
const XY_NODE_CONNECTOR_ID = 'ext_x_y'; // Use a unique ID
2121
let nodeConnector = NodeConnector.createNodeConnector(XY_NODE_CONNECTOR_ID, exports);
2222

23-
exports.modifyImage = async function(imageName, imageArrayBuffer) {
23+
exports.modifyImage = async function(imageName, imageArrayBuffer) \{
2424
// Perform image operations with the imageArrayBuffer
2525
// To return an ArrayBuffer, return an object with a `buffer` key.
26-
return {
26+
return \{
2727
operationDone: 'colored, cropped',
2828
buffer: imageArrayBuffer,
2929
};
@@ -36,7 +36,7 @@ exports.modifyImage = async function(imageName, imageArrayBuffer) {
3636
const XY_NODE_CONNECTOR_ID = 'ext_x_y'; // Use the same unique ID
3737
let nodeConnector = global.createNodeConnector(XY_NODE_CONNECTOR_ID, exports);
3838

39-
exports.getPWDRelative = async function(subPath) {
39+
exports.getPWDRelative = async function(subPath) \{
4040
return process.cwd + '/' + subPath;
4141
};
4242
```
@@ -56,7 +56,7 @@ To execute a Phoenix function from Node.js and transfer binary data, pass an opt
5656

5757
```js
5858
// In `y.js` (Node.js)
59-
const { operationDone, buffer } = await nodeConnector.execPeer('modifyImage', {name:'theHills.png'}, imageAsArrayBuffer);
59+
const \{ operationDone, buffer } = await nodeConnector.execPeer('modifyImage', \{name:'theHills.png'}, imageAsArrayBuffer);
6060
```
6161

6262
## Event Handling
@@ -66,11 +66,11 @@ to events between Node.js and Phoenix using the `triggerPeer` and (`on`, `one` o
6666

6767
```js
6868
// In `y.js` (Node.js)
69-
nodeConnector.on('phoenixProjectOpened', (_event, projectPath) => {
69+
nodeConnector.on('phoenixProjectOpened', (_event, projectPath) => \{
7070
console.log(projectPath);
7171
});
7272

73-
nodeConnector.one('phoenixProjectOpened', (_event, projectPath) => {
73+
nodeConnector.one('phoenixProjectOpened', (_event, projectPath) => \{
7474
console.log(projectPath + "will be received only once");
7575
});
7676
```
@@ -100,7 +100,7 @@ Example of calling a function in Node.js with binary data transfer:
100100

101101
```js
102102
// In `y.js` (Node.js)
103-
const { operationDone, buffer } = await nodeConnector.execPeer('modifyImage', {name:'name.png'}, imageArrayBuffer);
103+
const \{ operationDone, buffer } = await nodeConnector.execPeer('modifyImage', \{name:'name.png'}, imageArrayBuffer);
104104
```
105105

106106
### Handling ArrayBuffer Data in Event Handling
@@ -155,7 +155,7 @@ within a timeframe of less than 10 seconds(ideally same time) for seamless commu
155155

156156
* Throws **[Error][3]** If a node connector with the same ID already exists/invalid args passed.
157157

158-
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.
158+
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.
159159

160160
## isNodeAvailable
161161

docs/generatedApiDocs/features/NewFileContentManager-API.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ To get the default content given a path
106106
NewFileContentManager.getInitialContentForFile("/path/to/file.jsx");
107107
```
108108

109-
Returns **[Promise][2]<[string][1]>** The text contents
109+
Returns **[Promise][2] < [string][1]>** The text contents
110110

111111
[1]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
112112

docs/generatedApiDocs/utils/EventDispatcher-API.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,14 +66,14 @@ self.EventDispatcher.trigger("someEvent"); // within web worker
6666

6767
```js
6868
// in your extension js file.
69-
define (function (require, exports, module) {
69+
define (function (require, exports, module) \{
7070
const EventDispatcher = brackets.getModule("utils/EventDispatcher");
7171
EventDispatcher.makeEventDispatcher(exports); // This extension triggers some events
72-
let eventHandler = function (event, paramObject, paramVal) {
72+
let eventHandler = function (event, paramObject, paramVal) \{
7373
console.log(event, paramObject, paramVal);
7474
};
7575
exports.on("sampleEvent", eventHandler); // listen to our own event for demo
76-
exports.trigger("sampleEvent", { // trigger a sample event. This will activate the above listener 'on' function.
76+
exports.trigger("sampleEvent", \{ // trigger a sample event. This will activate the above listener 'on' function.
7777
param: 1,
7878
param2: "sample"
7979
}, "value");
@@ -93,7 +93,7 @@ Type: [function][2]
9393
* `eventStr`
9494
* `eventName` **[string][3]** Event name and/or trailing ".namespace"
9595
96-
Returns **!{event: [string][3], ns: [string][3]}** Uses "" for missing parts.
96+
Returns **!\{event: [string][3], ns: [string][3]}** Uses "" for missing parts.
9797
9898
## setLeakThresholdForEvent
9999

docs/generatedApiDocs/utils/StringUtils-API.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Splits the text by new line characters and returns an array of lines
2424

2525
* `text` **[string][1]**
2626

27-
Returns **[Array][2]<[string][1]>** lines
27+
Returns **[Array][2] < [string][1]>** lines
2828

2929
## offsetToLineNum
3030

@@ -38,7 +38,7 @@ this function to compute a line number from the offset.
3838

3939
### Parameters
4040

41-
* `textOrLines` **([string][1] | [Array][2]<[string][1]>)** string or array of lines from which
41+
* `textOrLines` **([string][1] | [Array][2] < [string][1]>)** string or array of lines from which
4242
to compute the line number from the offset
4343
* `offset` **[number][3]**
4444

0 commit comments

Comments
 (0)