docs: fix incorrect references, and grammatically errors (#39)

* docs: fix "Stream Deck +" references

* docs: fix param reference and local aliases

* docs: correct grammatical error

---------

Co-authored-by: Richard Herman <[email protected]>

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;
 };

src/api/events/action.ts

@@ -115,7 +115,7 @@ export type SingleActionPayload<TSettings extends JsonObject, TController extend
 
 	/**
 	 * 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 +.
 	 */
 	readonly controller: TController;
 
@@ -131,7 +131,7 @@ export type SingleActionPayload<TSettings extends JsonObject, TController extend
 export type MultiActionPayload<TSettings extends JsonObject> = ActionPayload<TSettings> & {
 	/**
 	 * 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.
 	 */

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">;
 

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 +). See also {@link DialUp}.
  *
  * NB: For other action types see {@link KeyDown}.
  */
 export type DialDown<TSettings extends JsonObject> = ActionEventMessage<"dialDown", EncoderPayload<TSettings>>;
 
 /**
- * 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}.
  */
 export type DialUp<TSettings extends JsonObject> = ActionEventMessage<"dialUp", EncoderPayload<TSettings>>;
 
 /**
- * Occurs when the user rotates a dial (Stream Deck+).
+ * Occurs when the user rotates a dial (Stream Deck +).
  */
 export type DialRotate<TSettings extends JsonObject> = ActionEventMessage<
 	"dialRotate",
@@ -35,7 +35,7 @@ export type DialRotate<TSettings extends JsonObject> = ActionEventMessage<
 >;
 
 /**
- * Occurs when the user taps the touchscreen (Stream Deck+).
+ * Occurs when the user taps the touchscreen (Stream Deck +).
  */
 export type TouchTap<TSettings extends JsonObject> = ActionEventMessage<
 	"touchTap",

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<TSettings extends JsonObject> = ActionEventMessage<"keyDown", KeypadPayload<TSettings>>;
 
 /**
- * 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}.
  */

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">;

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">;
 

src/api/registration/ui.ts

@@ -21,7 +21,7 @@ export type ActionInfo<T = unknown> = 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.
 			 */

src/plugin/actions/action.ts

@@ -203,7 +203,7 @@ export class Action<T extends JsonObject = JsonObject> 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.
 	 */

src/plugin/actions/index.ts

@@ -35,7 +35,7 @@ export function createController<T extends JsonObject = JsonObject>(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.
@@ -47,7 +47,7 @@ export function onDialDown<T extends JsonObject = JsonObject>(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<T extends JsonObject = JsonObject>(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<T extends JsonObject = JsonObject>(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<T extends JsonObject = JsonObject>(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<T extends JsonObject = JsonObject>(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.
@@ -105,7 +105,7 @@ export function onTitleParametersDidChange<T extends JsonObject = JsonObject>(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.

src/plugin/actions/singleton-action.ts

@@ -28,91 +28,91 @@ export class SingletonAction<T extends JsonObject = JsonObject> {
 	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 +). See also {@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<T>): Promise<void> | void;
 
 	/**
-	 * Occurs when the user rotates a dial (Stream Deck+).
-	 * @param listener Function to be invoked when the event occurs.
+	 * Occurs when the user rotates a dial (Stream Deck +).
+	 * @param ev The event.
 	 */
 	public onDialRotate?(ev: DialRotateEvent<T>): Promise<void> | 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 +). See also {@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<T>): Promise<void> | 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<T>): Promise<void> | void;
 
 	/**
-	 * Occurs when the user presses a action down. Also see {@link streamDeck.actions.onKeyUp}.
+	 * Occurs when the user presses a action down. See also {@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<T>): Promise<void> | void;
 
 	/**
-	 * Occurs when the user releases a pressed action. Also see {@link streamDeck.actions.onKeyDown}.
+	 * Occurs when the user releases a pressed action. See also {@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<T>): Promise<void> | 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. See also {@link streamDeck.ui.onDidAppear}.
+	 * @param ev The event.
 	 */
 	public onPropertyInspectorDidAppear?(ev: PropertyInspectorDidAppearEvent<T>): Promise<void> | 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. See also {@link streamDeck.ui.onDidDisappear}.
+	 * @param ev The event.
 	 */
 	public onPropertyInspectorDidDisappear?(ev: PropertyInspectorDidDisappearEvent<T>): Promise<void> | 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<JsonValue, T>): Promise<void> | 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.
+	 * 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<T>): Promise<void> | void;
 
 	/**
-	 * Occurs when the user taps the touchscreen (Stream Deck+).
-	 * @param listener Function to be invoked when the event occurs.
+	 * Occurs when the user taps the touchscreen (Stream Deck +).
+	 * @param ev The event.
 	 */
 	public onTouchTap?(ev: TouchTapEvent<T>): Promise<void> | 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<T>): Promise<void> | 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<T>): Promise<void> | void;
 }

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.
 	 */

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;
 

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.
  */