From a071948b2f10461044a5653b2d32af0abd6ba46f Mon Sep 17 00:00:00 2001 From: Richard Herman Date: Wed, 24 Apr 2024 14:18:35 +0100 Subject: [PATCH 1/3] docs: fix "Stream Deck +" references --- src/api/device.ts | 2 +- src/api/events/action.ts | 4 ++-- src/api/events/encoder.ts | 8 ++++---- src/api/registration/ui.ts | 2 +- src/plugin/actions/action.ts | 2 +- src/plugin/actions/index.ts | 8 ++++---- src/plugin/actions/singleton-action.ts | 8 ++++---- 7 files changed, 17 insertions(+), 17 deletions(-) diff --git a/src/api/device.ts b/src/api/device.ts index ff4cbb75..f8c149f7 100644 --- a/src/api/device.ts +++ b/src/api/device.ts @@ -17,7 +17,7 @@ export type DeviceInfo = { readonly size: Size; /** - * Type of the device that was connected, e.g. Stream Deck+, Stream Deck Pedal, etc. See {@link DeviceType}. + * Type of the device that was connected, e.g. Stream Deck +, Stream Deck Pedal, etc. See {@link DeviceType}. */ readonly type: DeviceType; }; diff --git a/src/api/events/action.ts b/src/api/events/action.ts index 96bf27d8..35a32be4 100644 --- a/src/api/events/action.ts +++ b/src/api/events/action.ts @@ -115,7 +115,7 @@ export type SingleActionPayload = ActionPayload & { /** * Defines the controller type the action is applicable to. **Keypad** refers to a standard action on a Stream Deck device, e.g. 1 of the 15 buttons on the Stream Deck MK.2, - * or a pedal on the Stream Deck Pedal, etc., whereas an **Encoder** refers to a dial / touchscreen on the Stream Deck+. + * or a pedal on the Stream Deck Pedal, etc., whereas an **Encoder** refers to a dial / touchscreen on the Stream Deck +. * * NB: Requires Stream Deck 6.5 for `WillAppear` and `WillDisappear` events. */ diff --git a/src/api/events/encoder.ts b/src/api/events/encoder.ts index 5c075e3e..972533cd 100644 --- a/src/api/events/encoder.ts +++ b/src/api/events/encoder.ts @@ -3,21 +3,21 @@ import type { ActionEventMessage, Coordinates, SingleActionPayload } from "./act import type { KeyDown, KeyUp } from "./keypad"; /** - * Occurs when the user presses a dial (Stream Deck+).Also see {@link DialUp}. + * Occurs when the user presses a dial (Stream Deck +).Also see {@link DialUp}. * * NB: For other action types see {@link KeyDown}. */ export type DialDown = ActionEventMessage<"dialDown", EncoderPayload>; /** - * Occurs when the user releases a pressed dial (Stream Deck+).Also see {@link DialDown}. + * Occurs when the user releases a pressed dial (Stream Deck +).Also see {@link DialDown}. * * NB: For other action types see {@link KeyUp}. */ export type DialUp = ActionEventMessage<"dialUp", EncoderPayload>; /** - * Occurs when the user rotates a dial (Stream Deck+). + * Occurs when the user rotates a dial (Stream Deck +). */ export type DialRotate = ActionEventMessage< "dialRotate", @@ -35,7 +35,7 @@ export type DialRotate = ActionEventMessage< >; /** - * Occurs when the user taps the touchscreen (Stream Deck+). + * Occurs when the user taps the touchscreen (Stream Deck +). */ export type TouchTap = ActionEventMessage< "touchTap", diff --git a/src/api/registration/ui.ts b/src/api/registration/ui.ts index 926bb1e4..7d9a162b 100644 --- a/src/api/registration/ui.ts +++ b/src/api/registration/ui.ts @@ -21,7 +21,7 @@ export type ActionInfo = ActionIdentifier & readonly payload: { /** * Defines the controller type the action is applicable to. **Keypad** refers to a standard action on a Stream Deck device, e.g. 1 of the 15 buttons on the Stream Deck MK.2, - * or a pedal on the Stream Deck Pedal, etc., whereas an **Encoder** refers to a dial / touchscreen on the Stream Deck+. + * or a pedal on the Stream Deck Pedal, etc., whereas an **Encoder** refers to a dial / touchscreen on the Stream Deck +. * * NB: Requires Stream Deck 6.5 for `WillAppear` and `WillDisappear` events. */ diff --git a/src/plugin/actions/action.ts b/src/plugin/actions/action.ts index d4489a73..5d4059b5 100644 --- a/src/plugin/actions/action.ts +++ b/src/plugin/actions/action.ts @@ -203,7 +203,7 @@ export class Action extends ActionContext { * will happen when they interact with the action, e.g. rotate, touch, etc. When {@link descriptions} is `undefined`, the descriptions will be reset to the values provided as part * of the manifest. * - * NB: Applies to encoders (dials / touchscreens) found on Stream Deck+ devices. + * NB: Applies to encoders (dials / touchscreens) found on Stream Deck + devices. * @param descriptions Descriptions that detail the action's interaction. * @returns `Promise` resolved when the request to set the {@link descriptions} has been sent to Stream Deck. */ diff --git a/src/plugin/actions/index.ts b/src/plugin/actions/index.ts index cfa93dc4..841187f3 100644 --- a/src/plugin/actions/index.ts +++ b/src/plugin/actions/index.ts @@ -35,7 +35,7 @@ export function createController(id: string): } /** - * Occurs when the user presses a dial (Stream Deck+). Also see {@link onDialUp}. + * Occurs when the user presses a dial (Stream Deck +). Also see {@link onDialUp}. * * NB: For other action types see {@link onKeyDown}. * @template T The type of settings associated with the action. @@ -47,7 +47,7 @@ export function onDialDown(listener: (ev: Dia } /** - * Occurs when the user rotates a dial (Stream Deck+). + * Occurs when the user rotates a dial (Stream Deck +). * @template T The type of settings associated with the action. * @param listener Function to be invoked when the event occurs. * @returns A disposable that, when disposed, removes the listener. @@ -57,7 +57,7 @@ export function onDialRotate(listener: (ev: D } /** - * Occurs when the user releases a pressed dial (Stream Deck+). Also see {@link onDialDown}. + * Occurs when the user releases a pressed dial (Stream Deck +). Also see {@link onDialDown}. * * NB: For other action types see {@link onKeyUp}. * @template T The type of settings associated with the action. @@ -105,7 +105,7 @@ export function onTitleParametersDidChange(li } /** - * Occurs when the user taps the touchscreen (Stream Deck+). + * Occurs when the user taps the touchscreen (Stream Deck +). * @template T The type of settings associated with the action. * @param listener Function to be invoked when the event occurs. * @returns A disposable that, when disposed, removes the listener. diff --git a/src/plugin/actions/singleton-action.ts b/src/plugin/actions/singleton-action.ts index 5266fa6f..f88cae6b 100644 --- a/src/plugin/actions/singleton-action.ts +++ b/src/plugin/actions/singleton-action.ts @@ -28,7 +28,7 @@ export class SingletonAction { public readonly manifestId: string | undefined; /** - * Occurs when the user presses a dial (Stream Deck+). Also see {@link streamDeck.actions.onDialUp}. + * Occurs when the user presses a dial (Stream Deck +). Also see {@link streamDeck.actions.onDialUp}. * * NB: For other action types see {@link streamDeck.actions.onKeyDown}. * @param listener Function to be invoked when the event occurs. @@ -36,13 +36,13 @@ export class SingletonAction { public onDialDown?(ev: DialDownEvent): Promise | void; /** - * Occurs when the user rotates a dial (Stream Deck+). + * Occurs when the user rotates a dial (Stream Deck +). * @param listener Function to be invoked when the event occurs. */ public onDialRotate?(ev: DialRotateEvent): Promise | void; /** - * Occurs when the user releases a pressed dial (Stream Deck+). Also see {@link streamDeck.actions.onDialDown}. + * Occurs when the user releases a pressed dial (Stream Deck +). Also see {@link streamDeck.actions.onDialDown}. * * NB: For other action types see {@link streamDeck.actions.onKeyUp}. * @param listener Function to be invoked when the event occurs. @@ -97,7 +97,7 @@ export class SingletonAction { public onTitleParametersDidChange?(ev: TitleParametersDidChangeEvent): Promise | void; /** - * Occurs when the user taps the touchscreen (Stream Deck+). + * Occurs when the user taps the touchscreen (Stream Deck +). * @param listener Function to be invoked when the event occurs. */ public onTouchTap?(ev: TouchTapEvent): Promise | void; From a74f96b0c798c651182f7fed347659aa23a8c649 Mon Sep 17 00:00:00 2001 From: Richard Herman Date: Wed, 24 Apr 2024 14:22:24 +0100 Subject: [PATCH 2/3] docs: fix param reference and local aliases --- src/plugin/actions/singleton-action.ts | 46 +++++++++++++------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/src/plugin/actions/singleton-action.ts b/src/plugin/actions/singleton-action.ts index f88cae6b..1e24c29d 100644 --- a/src/plugin/actions/singleton-action.ts +++ b/src/plugin/actions/singleton-action.ts @@ -28,91 +28,91 @@ export class SingletonAction { public readonly manifestId: string | undefined; /** - * Occurs when the user presses a dial (Stream Deck +). Also see {@link streamDeck.actions.onDialUp}. + * Occurs when the user presses a dial (Stream Deck +). Also see {@link SingletonAction.onDialUp}. * - * NB: For other action types see {@link streamDeck.actions.onKeyDown}. - * @param listener Function to be invoked when the event occurs. + * NB: For other action types see {@link SingletonAction.onKeyDown}. + * @param ev The event. */ public onDialDown?(ev: DialDownEvent): Promise | void; /** * Occurs when the user rotates a dial (Stream Deck +). - * @param listener Function to be invoked when the event occurs. + * @param ev The event. */ public onDialRotate?(ev: DialRotateEvent): Promise | void; /** - * Occurs when the user releases a pressed dial (Stream Deck +). Also see {@link streamDeck.actions.onDialDown}. + * Occurs when the user releases a pressed dial (Stream Deck +). Also see {@link SingletonAction.onDialDown}. * - * NB: For other action types see {@link streamDeck.actions.onKeyUp}. - * @param listener Function to be invoked when the event occurs. + * NB: For other action types see {@link SingletonAction.onKeyUp}. + * @param ev The event. */ public onDialUp?(ev: DialUpEvent): Promise | void; /** * Occurs when the settings associated with an action instance are requested using {@link Action.getSettings}, or when the the settings were updated by the property inspector. - * @param listener Function to be invoked when the event occurs. + * @param ev The event. */ public onDidReceiveSettings?(ev: DidReceiveSettingsEvent): Promise | void; /** - * Occurs when the user presses a action down. Also see {@link streamDeck.actions.onKeyUp}. + * Occurs when the user presses a action down. Also see {@link SingletonAction.onKeyUp}. * - * NB: For dials / touchscreens see {@link streamDeck.actions.onDialDown}. - * @param listener Function to be invoked when the event occurs. + * NB: For dials / touchscreens see {@link SingletonAction.onDialDown}. + * @param ev The event. */ public onKeyDown?(ev: KeyDownEvent): Promise | void; /** - * Occurs when the user releases a pressed action. Also see {@link streamDeck.actions.onKeyDown}. + * Occurs when the user releases a pressed action. Also see {@link SingletonAction.onKeyDown}. * - * NB: For dials / touchscreens see {@link streamDeck.actions.onDialUp}. - * @param listener Function to be invoked when the event occurs. + * NB: For dials / touchscreens see {@link SingletonAction.onDialUp}. + * @param ev The event. */ public onKeyUp?(ev: KeyUpEvent): Promise | void; /** - * Occurs when the property inspector associated with the action becomes visible, i.e. the user selected an action in the Stream Deck application. Also see {@link streamDeck.ui.onPropertyInspectorDidDisappear}. - * @param listener Function to be invoked when the event occurs. + * Occurs when the property inspector associated with the action becomes visible, i.e. the user selected an action in the Stream Deck application. Also see {@link streamDeck.ui.onDidAppear}. + * @param ev The event. */ public onPropertyInspectorDidAppear?(ev: PropertyInspectorDidAppearEvent): Promise | void; /** - * Occurs when the property inspector associated with the action becomes invisible, i.e. the user unselected the action in the Stream Deck application. Also see {@link streamDeck.ui.onPropertyInspectorDidAppear}. - * @param listener Function to be invoked when the event occurs. + * Occurs when the property inspector associated with the action becomes invisible, i.e. the user unselected the action in the Stream Deck application. Also see {@link streamDeck.ui.onDidDisappear}. + * @param ev The event. */ public onPropertyInspectorDidDisappear?(ev: PropertyInspectorDidDisappearEvent): Promise | void; /** * Occurs when a message was sent to the plugin _from_ the property inspector. The plugin can also send messages _to_ the property inspector using {@link Action.sendToPropertyInspector}. * @deprecated Consider using {@link streamDeck.ui.registerRoute} to receive requests from the property inspector. - * @param listener Function to be invoked when the event occurs. + * @param ev The event. */ public onSendToPlugin?(ev: SendToPluginEvent): Promise | void; /** * Occurs when the user updates an action's title settings in the Stream Deck application. Also see {@link Action.setTitle}. - * @param listener Function to be invoked when the event occurs. + * @param ev The event. */ public onTitleParametersDidChange?(ev: TitleParametersDidChangeEvent): Promise | void; /** * Occurs when the user taps the touchscreen (Stream Deck +). - * @param listener Function to be invoked when the event occurs. + * @param ev The event. */ public onTouchTap?(ev: TouchTapEvent): Promise | void; /** * Occurs when an action appears on the Stream Deck due to the user navigating to another page, profile, folder, etc. This also occurs during startup if the action is on the "front * page". An action refers to _all_ types of actions, e.g. keys, dials, - * @param listener Function to be invoked when the event occurs. + * @param ev The event. */ public onWillAppear?(ev: WillAppearEvent): Promise | void; /** * Occurs when an action disappears from the Stream Deck due to the user navigating to another page, profile, folder, etc. An action refers to _all_ types of actions, e.g. keys, * dials, touchscreens, pedals, etc. - * @param listener Function to be invoked when the event occurs. + * @param ev The event. */ public onWillDisappear?(ev: WillDisappearEvent): Promise | void; } From 07f89eb1cdd979a6962122c703247981deac9d8f Mon Sep 17 00:00:00 2001 From: Richard Herman Date: Wed, 24 Apr 2024 14:24:55 +0100 Subject: [PATCH 3/3] docs: correct grammatical error --- src/api/events/device.ts | 4 ++-- src/api/events/encoder.ts | 4 ++-- src/api/events/keypad.ts | 4 ++-- src/api/events/system.ts | 4 ++-- src/api/events/ui.ts | 4 ++-- src/plugin/actions/index.ts | 10 +++++----- src/plugin/actions/singleton-action.ts | 14 +++++++------- src/plugin/devices.ts | 4 ++-- src/plugin/events/deep-link-event.ts | 4 ++-- src/plugin/system.ts | 4 ++-- src/plugin/ui/controller.ts | 4 ++-- 11 files changed, 30 insertions(+), 30 deletions(-) diff --git a/src/api/events/device.ts b/src/api/events/device.ts index e9f4792b..2e19cb85 100644 --- a/src/api/events/device.ts +++ b/src/api/events/device.ts @@ -2,7 +2,7 @@ import type { DeviceInfo } from "../device"; import type { EventIdentifier } from "./index"; /** - * Occurs when a Stream Deck device is connected. Also see {@link DeviceDidDisconnect}. + * Occurs when a Stream Deck device is connected. See also {@link DeviceDidDisconnect}. */ export type DeviceDidConnect = DeviceIdentifier & EventIdentifier<"deviceDidConnect"> & { @@ -13,7 +13,7 @@ export type DeviceDidConnect = DeviceIdentifier & }; /** - * Occurs when a Stream Deck device is disconnected. Also see {@link DeviceDidConnect}. + * Occurs when a Stream Deck device is disconnected. See also {@link DeviceDidConnect}. */ export type DeviceDidDisconnect = DeviceIdentifier & EventIdentifier<"deviceDidDisconnect">; diff --git a/src/api/events/encoder.ts b/src/api/events/encoder.ts index 972533cd..ff78f255 100644 --- a/src/api/events/encoder.ts +++ b/src/api/events/encoder.ts @@ -3,14 +3,14 @@ import type { ActionEventMessage, Coordinates, SingleActionPayload } from "./act import type { KeyDown, KeyUp } from "./keypad"; /** - * Occurs when the user presses a dial (Stream Deck +).Also see {@link DialUp}. + * Occurs when the user presses a dial (Stream Deck +). See also {@link DialUp}. * * NB: For other action types see {@link KeyDown}. */ export type DialDown = ActionEventMessage<"dialDown", EncoderPayload>; /** - * Occurs when the user releases a pressed dial (Stream Deck +).Also see {@link DialDown}. + * Occurs when the user releases a pressed dial (Stream Deck +). See also {@link DialDown}. * * NB: For other action types see {@link KeyUp}. */ diff --git a/src/api/events/keypad.ts b/src/api/events/keypad.ts index 55cd044d..200dd148 100644 --- a/src/api/events/keypad.ts +++ b/src/api/events/keypad.ts @@ -3,14 +3,14 @@ import type { ActionEventMessage, MultiActionPayload, SingleActionPayload, State import type { DialDown, DialUp } from "./encoder"; /** - * Occurs when the user presses a action down. Also see {@link KeyUp}. + * Occurs when the user presses a action down. See also {@link KeyUp}. * * NB: For dials / touchscreens see {@link DialDown}. */ export type KeyDown = ActionEventMessage<"keyDown", KeypadPayload>; /** - * Occurs when the user releases a pressed action. Also see {@link KeyDown}. + * Occurs when the user releases a pressed action. See also {@link KeyDown}. * * NB: For dials / touchscreens see {@link DialUp}. */ diff --git a/src/api/events/system.ts b/src/api/events/system.ts index b91a21a6..3fa635e0 100644 --- a/src/api/events/system.ts +++ b/src/api/events/system.ts @@ -3,13 +3,13 @@ import type { JsonObject } from "../../common/json"; import type { EventIdentifier } from "./index"; /** - * Occurs when a monitored application is launched. Monitored applications can be defined in the `manifest.json` file via the {@link Manifest.ApplicationsToMonitor} property. Also see + * Occurs when a monitored application is launched. Monitored applications can be defined in the `manifest.json` file via the {@link Manifest.ApplicationsToMonitor} property. See also * {@link ApplicationDidTerminate}. */ export type ApplicationDidLaunch = ApplicationEventIdentifier<"applicationDidLaunch">; /** - * Occurs when a monitored application terminates. Monitored applications can be defined in the `manifest.json` file via the {@link Manifest.ApplicationsToMonitor} property. Also see + * Occurs when a monitored application terminates. Monitored applications can be defined in the `manifest.json` file via the {@link Manifest.ApplicationsToMonitor} property. See also * {@link ApplicationDidLaunch}. */ export type ApplicationDidTerminate = ApplicationEventIdentifier<"applicationDidTerminate">; diff --git a/src/api/events/ui.ts b/src/api/events/ui.ts index ade878ac..a5872c67 100644 --- a/src/api/events/ui.ts +++ b/src/api/events/ui.ts @@ -3,12 +3,12 @@ import type { ActionEventMessage } from "./action"; import type { DeviceIdentifier } from "./device"; /** - * Occurs when the property inspector associated with the action becomes visible, i.e. the user selected an action in the Stream Deck application. Also see {@link PropertyInspectorDidDisappear}. + * Occurs when the property inspector associated with the action becomes visible, i.e. the user selected an action in the Stream Deck application. See also {@link PropertyInspectorDidDisappear}. */ export type PropertyInspectorDidAppear = ActionEventMessage<"propertyInspectorDidAppear">; /** - * Occurs when the property inspector associated with the action becomes invisible, i.e. the user unselected the action in the Stream Deck application. Also see {@link PropertyInspectorDidAppear}. + * Occurs when the property inspector associated with the action becomes invisible, i.e. the user unselected the action in the Stream Deck application. See also {@link PropertyInspectorDidAppear}. */ export type PropertyInspectorDidDisappear = ActionEventMessage<"propertyInspectorDidDisappear">; diff --git a/src/plugin/actions/index.ts b/src/plugin/actions/index.ts index 841187f3..880c5a9c 100644 --- a/src/plugin/actions/index.ts +++ b/src/plugin/actions/index.ts @@ -35,7 +35,7 @@ export function createController(id: string): } /** - * Occurs when the user presses a dial (Stream Deck +). Also see {@link onDialUp}. + * Occurs when the user presses a dial (Stream Deck +). See also {@link onDialUp}. * * NB: For other action types see {@link onKeyDown}. * @template T The type of settings associated with the action. @@ -57,7 +57,7 @@ export function onDialRotate(listener: (ev: D } /** - * Occurs when the user releases a pressed dial (Stream Deck +). Also see {@link onDialDown}. + * Occurs when the user releases a pressed dial (Stream Deck +). See also {@link onDialDown}. * * NB: For other action types see {@link onKeyUp}. * @template T The type of settings associated with the action. @@ -69,7 +69,7 @@ export function onDialUp(listener: (ev: DialU } /** - * Occurs when the user presses a action down. Also see {@link onKeyUp}. + * Occurs when the user presses a action down. See also {@link onKeyUp}. * * NB: For dials / touchscreens see {@link onDialDown}. * @template T The type of settings associated with the action. @@ -81,7 +81,7 @@ export function onKeyDown(listener: (ev: KeyD } /** - * Occurs when the user releases a pressed action. Also see {@link onKeyDown}. + * Occurs when the user releases a pressed action. See also {@link onKeyDown}. * * NB: For dials / touchscreens see {@link onDialUp}. * @template T The type of settings associated with the action. @@ -93,7 +93,7 @@ export function onKeyUp(listener: (ev: KeyUpE } /** - * Occurs when the user updates an action's title settings in the Stream Deck application. Also see {@link Action.setTitle}. + * Occurs when the user updates an action's title settings in the Stream Deck application. See also {@link Action.setTitle}. * @template T The type of settings associated with the action. * @param listener Function to be invoked when the event occurs. * @returns A disposable that, when disposed, removes the listener. diff --git a/src/plugin/actions/singleton-action.ts b/src/plugin/actions/singleton-action.ts index 1e24c29d..1a6fb9ba 100644 --- a/src/plugin/actions/singleton-action.ts +++ b/src/plugin/actions/singleton-action.ts @@ -28,7 +28,7 @@ export class SingletonAction { public readonly manifestId: string | undefined; /** - * Occurs when the user presses a dial (Stream Deck +). Also see {@link SingletonAction.onDialUp}. + * Occurs when the user presses a dial (Stream Deck +). See also {@link SingletonAction.onDialUp}. * * NB: For other action types see {@link SingletonAction.onKeyDown}. * @param ev The event. @@ -42,7 +42,7 @@ export class SingletonAction { public onDialRotate?(ev: DialRotateEvent): Promise | void; /** - * Occurs when the user releases a pressed dial (Stream Deck +). Also see {@link SingletonAction.onDialDown}. + * Occurs when the user releases a pressed dial (Stream Deck +). See also {@link SingletonAction.onDialDown}. * * NB: For other action types see {@link SingletonAction.onKeyUp}. * @param ev The event. @@ -56,7 +56,7 @@ export class SingletonAction { public onDidReceiveSettings?(ev: DidReceiveSettingsEvent): Promise | void; /** - * Occurs when the user presses a action down. Also see {@link SingletonAction.onKeyUp}. + * Occurs when the user presses a action down. See also {@link SingletonAction.onKeyUp}. * * NB: For dials / touchscreens see {@link SingletonAction.onDialDown}. * @param ev The event. @@ -64,7 +64,7 @@ export class SingletonAction { public onKeyDown?(ev: KeyDownEvent): Promise | void; /** - * Occurs when the user releases a pressed action. Also see {@link SingletonAction.onKeyDown}. + * Occurs when the user releases a pressed action. See also {@link SingletonAction.onKeyDown}. * * NB: For dials / touchscreens see {@link SingletonAction.onDialUp}. * @param ev The event. @@ -72,13 +72,13 @@ export class SingletonAction { public onKeyUp?(ev: KeyUpEvent): Promise | void; /** - * Occurs when the property inspector associated with the action becomes visible, i.e. the user selected an action in the Stream Deck application. Also see {@link streamDeck.ui.onDidAppear}. + * Occurs when the property inspector associated with the action becomes visible, i.e. the user selected an action in the Stream Deck application. See also {@link streamDeck.ui.onDidAppear}. * @param ev The event. */ public onPropertyInspectorDidAppear?(ev: PropertyInspectorDidAppearEvent): Promise | void; /** - * Occurs when the property inspector associated with the action becomes invisible, i.e. the user unselected the action in the Stream Deck application. Also see {@link streamDeck.ui.onDidDisappear}. + * Occurs when the property inspector associated with the action becomes invisible, i.e. the user unselected the action in the Stream Deck application. See also {@link streamDeck.ui.onDidDisappear}. * @param ev The event. */ public onPropertyInspectorDidDisappear?(ev: PropertyInspectorDidDisappearEvent): Promise | void; @@ -91,7 +91,7 @@ export class SingletonAction { public onSendToPlugin?(ev: SendToPluginEvent): Promise | void; /** - * Occurs when the user updates an action's title settings in the Stream Deck application. Also see {@link Action.setTitle}. + * Occurs when the user updates an action's title settings in the Stream Deck application. See also {@link Action.setTitle}. * @param ev The event. */ public onTitleParametersDidChange?(ev: TitleParametersDidChangeEvent): Promise | void; diff --git a/src/plugin/devices.ts b/src/plugin/devices.ts index fc77440e..6a74348a 100644 --- a/src/plugin/devices.ts +++ b/src/plugin/devices.ts @@ -81,7 +81,7 @@ class DeviceCollection { } /** - * Occurs when a Stream Deck device is connected. Also see {@link DeviceCollection.onDeviceDidConnect}. + * Occurs when a Stream Deck device is connected. See also {@link DeviceCollection.onDeviceDidConnect}. * @param listener Function to be invoked when the event occurs. * @returns A disposable that, when disposed, removes the listener. */ @@ -97,7 +97,7 @@ class DeviceCollection { } /** - * Occurs when a Stream Deck device is disconnected. Also see {@link DeviceCollection.onDeviceDidDisconnect}. + * Occurs when a Stream Deck device is disconnected. See also {@link DeviceCollection.onDeviceDidDisconnect}. * @param listener Function to be invoked when the event occurs. * @returns A disposable that, when disposed, removes the listener. */ diff --git a/src/plugin/events/deep-link-event.ts b/src/plugin/events/deep-link-event.ts index daab5543..91302624 100644 --- a/src/plugin/events/deep-link-event.ts +++ b/src/plugin/events/deep-link-event.ts @@ -43,12 +43,12 @@ export class DeepLinkURL { /** * Query of the URL, with the question mark (?) omitted. For example, a URL of "/test?name=elgato&key=123" would result in a {@link DeepLinkURL.query} of "name=elgato&key=123". - * Also see {@link DeepLinkURL.queryParameters}. + * See also {@link DeepLinkURL.queryParameters}. */ public readonly query: string; /** - * Query string parameters parsed from the URL. Also see {@link DeepLinkURL.query}. + * Query string parameters parsed from the URL. See also {@link DeepLinkURL.query}. */ public readonly queryParameters: URLSearchParams; diff --git a/src/plugin/system.ts b/src/plugin/system.ts index a4c69765..316da1eb 100644 --- a/src/plugin/system.ts +++ b/src/plugin/system.ts @@ -6,7 +6,7 @@ import { requiresVersion } from "./validation"; /** * Occurs when a monitored application is launched. Monitored applications can be defined in the manifest via the {@link Manifest.ApplicationsToMonitor} property. - * Also see {@link onApplicationDidTerminate}. + * See also {@link onApplicationDidTerminate}. * @param listener Function to be invoked when the event occurs. * @returns A disposable that, when disposed, removes the listener. */ @@ -16,7 +16,7 @@ export function onApplicationDidLaunch(listener: (ev: ApplicationDidLaunchEvent) /** * Occurs when a monitored application terminates. Monitored applications can be defined in the manifest via the {@link Manifest.ApplicationsToMonitor} property. - * Also see {@link onApplicationDidLaunch}. + * See also {@link onApplicationDidLaunch}. * @param listener Function to be invoked when the event occurs. * @returns A disposable that, when disposed, removes the listener. */ diff --git a/src/plugin/ui/controller.ts b/src/plugin/ui/controller.ts index 1c2bbb19..315b54be 100644 --- a/src/plugin/ui/controller.ts +++ b/src/plugin/ui/controller.ts @@ -23,7 +23,7 @@ class UIController { } /** - * Occurs when the property inspector associated with the action becomes visible, i.e. the user selected an action in the Stream Deck application. Also see {@link UIController.onDidDisappear}. + * Occurs when the property inspector associated with the action becomes visible, i.e. the user selected an action in the Stream Deck application. See also {@link UIController.onDidDisappear}. * @template T The type of settings associated with the action. * @param listener Function to be invoked when the event occurs. * @returns A disposable that, when disposed, removes the listener. @@ -33,7 +33,7 @@ class UIController { } /** - * Occurs when the property inspector associated with the action becomes destroyed, i.e. the user unselected the action in the Stream Deck application. Also see {@link UIController.onDidAppear}. + * Occurs when the property inspector associated with the action becomes destroyed, i.e. the user unselected the action in the Stream Deck application. See also {@link UIController.onDidAppear}. * @template T The type of settings associated with the action. * @param listener Function to be invoked when the event occurs. * @returns A disposable that, when disposed, removes the listener.