Skip to content

Commit 59b786f

Browse files
committed
docs: fix additional build fail issues
1 parent 010dfdc commit 59b786f

File tree

4 files changed

+13
-12
lines changed

4 files changed

+13
-12
lines changed

docs/API-Reference/command/KeyBindingManager.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,27 +81,27 @@ In the default keymap each key is associated with an object containing `commandI
8181

8282
<a name="addBinding"></a>
8383

84-
## addBinding(command, keyBindings, platform, options) ⇒ <code>Object</code> \| <code>Array.&lt;{key: string, displayKey:String}&gt;</code>
84+
## addBinding(command, keyBindings, platform, options) ⇒ <code>Object</code>
8585
Add one or more key bindings to a particular Command.
86+
Returns record(s) for valid key binding(s).
8687

8788
**Kind**: global function
88-
**Returns**: <code>Object</code> \| <code>Array.&lt;{key: string, displayKey:String}&gt;</code> - Returns record(s) for valid key binding(s)
8989

9090
| Param | Type | Description |
9191
| --- | --- | --- |
9292
| command | <code>string</code> \| <code>Command</code> | A command ID or command object |
93-
| keyBindings | <code>Object</code> \| <code>Array.&lt;{key: string, displayKey: string, platform: string}&gt;</code> | A single key binding or an array of keybindings. Example: "Shift-Cmd-F". Mac and Win key equivalents are automatically mapped to each other. Use displayKey property to display a different string (e.g. "CMD+" instead of "CMD="). |
93+
| keyBindings | <code>Object</code> | A single key binding or an array of keybindings. In an array of keybinding `platform` property is also available. Example: "Shift-Cmd-F". Mac and Win key equivalents are automatically mapped to each other. Use displayKey property to display a different string (e.g. "CMD+" instead of "CMD="). |
9494
| platform | <code>string</code> | The target OS of the keyBindings either "mac", "win" or "linux". If undefined, all platforms not explicitly defined will use the key binding. NOTE: If platform is not specified, Ctrl will be replaced by Cmd for "mac" platform |
9595
| options | <code>object</code> | |
9696
| options.isMenuShortcut | <code>boolean</code> | this allows alt-key shortcuts to be registered. |
9797

9898
<a name="getKeyBindings"></a>
9999

100-
## getKeyBindings(command) ⇒ <code>Array.&lt;{{key: string, displayKey: string}}&gt;</code>
100+
## getKeyBindings(command) ⇒ <code>Array.&lt;Object&gt;</code>
101101
Retrieve key bindings currently associated with a command
102102

103103
**Kind**: global function
104-
**Returns**: <code>Array.&lt;{{key: string, displayKey: string}}&gt;</code> - An array of associated key bindings.
104+
**Returns**: <code>Array.&lt;Object&gt;</code> - The object has two properties `key` and `displayKey`
105105

106106
| Param | Type | Description |
107107
| --- | --- | --- |

docs/API-Reference/widgets/Dialogs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ be called with the special buttonId DIALOG_CANCELED (note: callback is run async
144144
<a name="addLinkTooltips"></a>
145145

146146
## addLinkTooltips(elementOrDialog)
147-
Ensures that all <a> tags with a URL have a tooltip showing the same URL
147+
Ensures that all anchor tags with a URL have a tooltip showing the same URL
148148

149149
**Kind**: global function
150150

src/command/KeyBindingManager.js

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -980,10 +980,12 @@ define(function (require, exports, module) {
980980

981981
/**
982982
* Add one or more key bindings to a particular Command.
983+
* Returns record(s) for valid key binding(s).
983984
*
984985
* @param {!string | Command} command - A command ID or command object
985-
* @param {?({key: string, displayKey: string}|Array.<{key: string, displayKey: string, platform: string}>)} keyBindings
986-
* A single key binding or an array of keybindings. Example:
986+
* @param {{key: string, displayKey:string, platform: string}} keyBindings
987+
* A single key binding or an array of keybindings.
988+
* In an array of keybinding `platform` property is also available. Example:
987989
* "Shift-Cmd-F". Mac and Win key equivalents are automatically
988990
* mapped to each other. Use displayKey property to display a different
989991
* string (e.g. "CMD+" instead of "CMD=").
@@ -993,8 +995,7 @@ define(function (require, exports, module) {
993995
* NOTE: If platform is not specified, Ctrl will be replaced by Cmd for "mac" platform
994996
* @param {object?} options
995997
* @param {boolean?} options.isMenuShortcut this allows alt-key shortcuts to be registered.
996-
* @return {{key: string, displayKey:String}|Array.<{key: string, displayKey:String}>}
997-
* Returns record(s) for valid key binding(s)
998+
* @return {{key: string, displayKey:string}}
998999
*/
9991000
function addBinding(command, keyBindings, platform, options={}) {
10001001
let commandID = "",
@@ -1045,7 +1046,7 @@ define(function (require, exports, module) {
10451046
* Retrieve key bindings currently associated with a command
10461047
*
10471048
* @param {!string | Command} command - A command ID or command object
1048-
* @return {!Array.<{{key: string, displayKey: string}}>} An array of associated key bindings.
1049+
* @return {Array.<Object>} The object has two properties `key` and `displayKey`
10491050
*/
10501051
function getKeyBindings(command) {
10511052
let bindings = [],

src/widgets/Dialogs.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -552,7 +552,7 @@ define(function (require, exports, module) {
552552
});
553553

554554
/**
555-
* Ensures that all <a> tags with a URL have a tooltip showing the same URL
555+
* Ensures that all anchor tags with a URL have a tooltip showing the same URL
556556
* @param {!jQueryObject|Dialog} elementOrDialog Dialog intance, or root of other DOM tree to add tooltips to
557557
*/
558558
function addLinkTooltips(elementOrDialog) {

0 commit comments

Comments
 (0)