Skip to content

Commit cde7396

Browse files
committed
docs: fix misspellings in JSDoc and the generated API reference
overriden -> overridden, fucntion -> function, seperated -> separated, specifed -> specified, persistant -> persistent. docs/API-Reference/ is generated from JSDoc, so each fix is applied to the source comment and to the generated page, keeping the two in sync.
1 parent ffe4019 commit cde7396

15 files changed

Lines changed: 16 additions & 16 deletions

File tree

‎docs/API-Reference/command/KeyBindingManager.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ to display the shortcut selection dialog
224224
<a name="canAssignBinding"></a>
225225

226226
## canAssignBinding(commandId) ⇒ <code>boolean</code>
227-
Returns true the given command id can be overriden by user.
227+
Returns true the given command id can be overridden by user.
228228

229229
**Kind**: global function
230230

‎docs/API-Reference/features/QuickViewManager.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,6 @@ is called or document changes.
186186
<a name="module_features/QuickViewManager..unlockQuickView"></a>
187187

188188
### features/QuickViewManager.unlockQuickView() : <code>function</code>
189-
unlocks the current QuickView locked by `lockQuickView` fucntion.
189+
unlocks the current QuickView locked by `lockQuickView` function.
190190

191191
**Kind**: inner method of [<code>features/QuickViewManager</code>](#module_features/QuickViewManager)

‎docs/API-Reference/preferences/StateManager.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Convenience function that sets a view state and then saves the file
6161
<a name="definePreferenceInternal"></a>
6262

6363
## definePreferenceInternal(id, type, initial, options) ⇒ <code>Object</code>
64-
returns a preference instance that can be listened `.on("change", cbfn(changeType))` . The callback fucntion will be called
64+
returns a preference instance that can be listened `.on("change", cbfn(changeType))` . The callback function will be called
6565
whenever there is a change in the supplied id with a changeType argument. The change type can be one of the two:
6666
CHANGE_TYPE_INTERNAL - if change is made within the current app window/browser tap
6767
CHANGE_TYPE_EXTERNAL - if change is made in a different app window/browser tab

‎docs/API-Reference/utils/EventManager.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ EventManager.triggerEvent("closeDialogueHandler", "someEvent", "param1", "param2
9090
| --- | --- | --- |
9191
| handlerName | <code>string</code> | |
9292
| eventName | | the event name as recognised by the handler. this is usually a string. |
93-
| ...eventParams | | Can be a comma seperated list of args or a single argument. |
93+
| ...eventParams | | Can be a comma separated list of args or a single argument. |
9494

9595
<a name="module_utils/EventManager..setTrustedOrigin"></a>
9696

‎docs/API-Reference/view/Pane.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -586,7 +586,7 @@ Removes the view and opens the next view
586586
<a name="module_view/Pane..Pane+removeViews"></a>
587587
588588
#### pane.removeViews(list) ⇒ <code>Array.&lt;File&gt;</code>
589-
Removes the specifed file from all internal lists, destroys the view of the file (if there is one)
589+
Removes the specified file from all internal lists, destroys the view of the file (if there is one)
590590
and shows the interstitial page if the current view is destroyed.
591591
592592
**Kind**: instance method of [<code>Pane</code>](#module_view/Pane..Pane)

‎docs/API-Reference/widgets/PopUpManager.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Add Esc key handling for a popup DOM element.
2020
| --- | --- | --- |
2121
| $popUp | <code>jQuery</code> | jQuery object for the DOM element pop-up |
2222
| removeHandler | <code>function</code> | Pop-up specific remove (e.g. display:none or DOM removal) |
23-
| autoRemove | <code>Boolean</code> | Specify true to indicate the PopUpManager should remove the popup from the _popUps array when the popup is closed. Specify false when the popup is always persistant in the _popUps array. |
23+
| autoRemove | <code>Boolean</code> | Specify true to indicate the PopUpManager should remove the popup from the _popUps array when the popup is closed. Specify false when the popup is always persistent in the _popUps array. |
2424
| options | <code>object</code> | |
2525
| [options.popupManagesFocus] | <code>boolean</code> | set to true if the popup manages focus restore on close |
2626
| [options.closeCurrentPopups] | <code>boolean</code> | set to true if you want to dismiss all exiting popups before adding this. Useful when this should be the only popup visible. |

‎src/command/KeyBindingManager.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2163,7 +2163,7 @@ define(function (require, exports, module) {
21632163
}
21642164

21652165
/**
2166-
* Returns true the given command id can be overriden by user.
2166+
* Returns true the given command id can be overridden by user.
21672167
*
21682168
* @param commandId
21692169
* @return {boolean}

‎src/editor/CodeHintList.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ define(function (require, exports, module) {
6464
this.selectedIndex = -1;
6565

6666
/**
67-
* The maximum number of hints to display. Can be overriden via maxCodeHints pref
67+
* The maximum number of hints to display. Can be overridden via maxCodeHints pref
6868
*
6969
* @type {number}
7070
*/

‎src/features/QuickViewManager.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -794,7 +794,7 @@ define(function (require, exports, module) {
794794
}
795795

796796
/**
797-
* unlocks the current QuickView locked by `lockQuickView` fucntion.
797+
* unlocks the current QuickView locked by `lockQuickView` function.
798798
*
799799
* @type {function}
800800
*/

‎src/preferences/PreferencesManager.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ define(function (require, exports, module) {
226226
*
227227
* This function is used internally to set the current language of the document.
228228
* Both at the moment of opening the file and when the language is manually
229-
* overriden.
229+
* overridden.
230230
*
231231
* @param {string} newLanguageId The id of the language of the current editor.
232232
*/

0 commit comments

Comments
 (0)