Skip to content

Commit 34621be

Browse files
devvaannshabose
authored andcommitted
Fix: JSDoc issues in file
1 parent 26a2095 commit 34621be

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

src/utils/EventManager.js

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,10 @@ define(function (require, exports, module) {
6262
* EventDispatcher.makeEventDispatcher(exports);
6363
* const EventManager = brackets.getModule("utils/EventManager");
6464
*
65-
* // Note: for event handler names, please change the <extensionName> to your extension name
65+
* // Note: for event handler names, please change the `extensionName` to your extension name
6666
* // to prevent collisions. EventHandlers starting with `ph-` and `br-` are reserved as system handlers
6767
* // and not available for use in extensions.
68-
* EventManager.registerEventHandler("<extensionName>-closeDialogueHandler", exports);
68+
* EventManager.registerEventHandler("`extensionName`-closeDialogueHandler", exports);
6969
* // Once the event handler is registered, see triggerEvent API on how to raise events
7070
*
7171
* @param {string} handlerName a unique name of the handler.
@@ -121,8 +121,8 @@ define(function (require, exports, module) {
121121
* listen to these events should register their named eventHandler with `EventManager`.
122122
*
123123
* By default, only origins part of `window.Phoenix.TRUSTED_ORIGINS` are whitelisted. If your extension is
124-
* bringing in a cross-origin ifrmame say `http://mydomain.com`, you should add it to the whitelist by setting
125-
* `window.Phoenix.TRUSTED_ORIGINS["http://mydomain.com"]=true;`
124+
* bringing in a cross-origin ifrmame say (`http://mydomain.com`), you should add it to the whitelist by setting
125+
* `window.Phoenix.TRUSTED_ORIGINS ("http://mydomain.com") = true;`
126126
*
127127
* @function
128128
* @global
@@ -138,18 +138,18 @@ define(function (require, exports, module) {
138138
* const EventDispatcher = brackets.getModule("utils/EventDispatcher"),
139139
* EventDispatcher.makeEventDispatcher(exports);
140140
* const EventManager = brackets.getModule("utils/EventManager");
141-
* // Note: for event handler names, please change the <extensionName> to your extension name
141+
* // Note: for event handler names, please change the `extensionName` to your extension name
142142
* // to prevent collisions. EventHandlers starting with `ph-` and `br-` are reserved as system handlers
143143
* // and not available for use in extensions.
144-
* window.Phoenix.TRUSTED_ORIGINS["http://mydomain.com"]=true;
145-
* EventManager.registerEventHandler("<extensionName>-iframeMessageHandler", exports);
144+
* window.Phoenix.TRUSTED_ORIGINS ("http://mydomain.com") = true;
145+
* EventManager.registerEventHandler("`extensionName`-iframeMessageHandler", exports);
146146
* exports.on("iframeHelloEvent", function(_ev, event){
147147
* console.log(event.data.message);
148148
* });
149149
*
150150
* // Now from your iframe, send a message to the above event handler using:
151151
* window.parent.postMessage({
152-
* handlerName: "<extensionName>-iframeMessageHandler",
152+
* handlerName: "`extensionName`-iframeMessageHandler",
153153
* eventName: "iframeHelloEvent",
154154
* message: "hello world"
155155
* }, '*');

0 commit comments

Comments
 (0)