Skip to content

Commit 07c538d

Browse files
agiletortoiseagiletortoise
committed
fix some deprecated method docs
1 parent 8220a3a commit 07c538d

File tree

9 files changed

+87
-33
lines changed

9 files changed

+87
-33
lines changed

‎docs/assets/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/classes/Window.html

Lines changed: 10 additions & 4 deletions
Large diffs are not rendered by default.

‎docs/classes/app.html

Lines changed: 7 additions & 7 deletions
Large diffs are not rendered by default.

‎docs/classes/draft.html

Lines changed: 3 additions & 3 deletions
Large diffs are not rendered by default.

‎docs/drafts-definitions.js

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -561,19 +561,19 @@ declare class App {
561561
openInNewWindow(draft: Draft): boolean
562562

563563
/**
564-
* Load the ActionGroup in the action list side bar.
565-
* @category Interface
564+
* @deprecated Use `app.currentWindow.loadActionGroup`
565+
* @category Deprecated
566566
*/
567567
loadActionGroup(actionGroup: ActionGroup): boolean
568568

569569
/**
570-
* Load the ActionGroup in the action bar below editor.
571-
* @category Interface
570+
* @deprecated Use `app.currentWindow.loadActionBarGroup`
571+
* @category Deprecated
572572
*/
573573
loadActionBarGroup(actionGroup: ActionGroup): boolean
574574

575575
/**
576-
* @deprecated replaced by `loadActionBarGroup`.
576+
* @deprecated Use `app.currentWindow.loadActionBarGroup`
577577
* @category Deprecated
578578
*/
579579
loadKeyboardActionGroup(actionGroup: ActionGroup): boolean
@@ -1410,7 +1410,7 @@ declare class Draft {
14101410
/**
14111411
* Convenience method to filter lines of a draft, returning only the lines that begin with a certain string.
14121412
*/
1413-
linesWithPrefex(prefix: string): [string]
1413+
linesWithPrefix(prefix: string): [string]
14141414

14151415
/**
14161416
* Convenience method to scan the draft content for valid URLs, and return all found URLs as an array. This will return valid full URL strings - both for `http(s)` and custom URLs found in the text.
@@ -5589,6 +5589,24 @@ declare class Window {
55895589
* @category Interface
55905590
*/
55915591
hideActionList(): void
5592+
5593+
/**
5594+
* Load the ActionGroup in the action list side bar.
5595+
* @category Interface
5596+
*/
5597+
loadActionGroup(actionGroup: ActionGroup): boolean
5598+
5599+
/**
5600+
* Load the ActionGroup in the action bar below editor.
5601+
* @category Interface
5602+
*/
5603+
loadActionBarGroup(actionGroup: ActionGroup): boolean
5604+
5605+
/**
5606+
* @deprecated replaced by `loadActionBarGroup`.
5607+
* @category Deprecated
5608+
*/
5609+
loadKeyboardActionGroup(actionGroup: ActionGroup): boolean
55925610
}
55935611
/**
55945612
* Script integration with WordPress sites via the [WordPress XML-RPC API](https://codex.wordpress.org/XML-RPC_WordPress_API). Currently this object has one runMethod function which can be used to call any method available in the XML-RPC interface.

‎src-individual/App.d.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -120,19 +120,19 @@ declare class App {
120120
openInNewWindow(draft: Draft): boolean
121121

122122
/**
123-
* Load the ActionGroup in the action list side bar.
124-
* @category Interface
123+
* @deprecated Use `app.currentWindow.loadActionGroup`
124+
* @category Deprecated
125125
*/
126126
loadActionGroup(actionGroup: ActionGroup): boolean
127127

128128
/**
129-
* Load the ActionGroup in the action bar below editor.
130-
* @category Interface
129+
* @deprecated Use `app.currentWindow.loadActionBarGroup`
130+
* @category Deprecated
131131
*/
132132
loadActionBarGroup(actionGroup: ActionGroup): boolean
133133

134134
/**
135-
* @deprecated replaced by `loadActionBarGroup`.
135+
* @deprecated Use `app.currentWindow.loadActionBarGroup`
136136
* @category Deprecated
137137
*/
138138
loadKeyboardActionGroup(actionGroup: ActionGroup): boolean

‎src-individual/Draft.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ declare class Draft {
5555
/**
5656
* Convenience method to filter lines of a draft, returning only the lines that begin with a certain string.
5757
*/
58-
linesWithPrefex(prefix: string): [string]
58+
linesWithPrefix(prefix: string): [string]
5959

6060
/**
6161
* Convenience method to scan the draft content for valid URLs, and return all found URLs as an array. This will return valid full URL strings - both for `http(s)` and custom URLs found in the text.

‎src-individual/Window.d.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,4 +76,16 @@ declare class Window {
7676
* @category Interface
7777
*/
7878
hideActionList(): void
79+
80+
/**
81+
* Load the ActionGroup in the action list side bar.
82+
* @category Interface
83+
*/
84+
loadActionGroup(actionGroup: ActionGroup): boolean
85+
86+
/**
87+
* Load the ActionGroup in the action bar below editor.
88+
* @category Interface
89+
*/
90+
loadActionBarGroup(actionGroup: ActionGroup): boolean
7991
}

‎src/drafts.d.ts

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -561,19 +561,19 @@ declare class App {
561561
openInNewWindow(draft: Draft): boolean
562562

563563
/**
564-
* Load the ActionGroup in the action list side bar.
565-
* @category Interface
564+
* @deprecated Use `app.currentWindow.loadActionGroup`
565+
* @category Deprecated
566566
*/
567567
loadActionGroup(actionGroup: ActionGroup): boolean
568568

569569
/**
570-
* Load the ActionGroup in the action bar below editor.
571-
* @category Interface
570+
* @deprecated Use `app.currentWindow.loadActionBarGroup`
571+
* @category Deprecated
572572
*/
573573
loadActionBarGroup(actionGroup: ActionGroup): boolean
574574

575575
/**
576-
* @deprecated replaced by `loadActionBarGroup`.
576+
* @deprecated Use `app.currentWindow.loadActionBarGroup`
577577
* @category Deprecated
578578
*/
579579
loadKeyboardActionGroup(actionGroup: ActionGroup): boolean
@@ -1410,7 +1410,7 @@ declare class Draft {
14101410
/**
14111411
* Convenience method to filter lines of a draft, returning only the lines that begin with a certain string.
14121412
*/
1413-
linesWithPrefex(prefix: string): [string]
1413+
linesWithPrefix(prefix: string): [string]
14141414

14151415
/**
14161416
* Convenience method to scan the draft content for valid URLs, and return all found URLs as an array. This will return valid full URL strings - both for `http(s)` and custom URLs found in the text.
@@ -5589,6 +5589,24 @@ declare class Window {
55895589
* @category Interface
55905590
*/
55915591
hideActionList(): void
5592+
5593+
/**
5594+
* Load the ActionGroup in the action list side bar.
5595+
* @category Interface
5596+
*/
5597+
loadActionGroup(actionGroup: ActionGroup): boolean
5598+
5599+
/**
5600+
* Load the ActionGroup in the action bar below editor.
5601+
* @category Interface
5602+
*/
5603+
loadActionBarGroup(actionGroup: ActionGroup): boolean
5604+
5605+
/**
5606+
* @deprecated replaced by `loadActionBarGroup`.
5607+
* @category Deprecated
5608+
*/
5609+
loadKeyboardActionGroup(actionGroup: ActionGroup): boolean
55925610
}
55935611
/**
55945612
* Script integration with WordPress sites via the [WordPress XML-RPC API](https://codex.wordpress.org/XML-RPC_WordPress_API). Currently this object has one runMethod function which can be used to call any method available in the XML-RPC interface.

0 commit comments

Comments
 (0)