(#87) Native provider interface docs

Author: s1hofmann

Diff for: lib/provider/native/clipboard-action-provider.interface.ts

@@ -1,38 +1,32 @@
 /**
  * A ClipboardActionProvider should allow access to the system clipboard
- *
- * @interface ClipboardActionProvider
  */
 export interface ClipboardActionProvider {
   /**
    * hasText should return whether the system clipboard currently holds text or not
    *
-   * @returns {Promise<boolean>} True if there's text on the clipboard, false otherwise
-   * @memberof ClipboardActionProvider
+   * @returns True if there's text on the clipboard, false otherwise
    */
   hasText(): Promise<boolean>;
 
   /**
    * clear should allow to clear the system clipboard
    *
-   * @returns {Promise<boolean>} Successfully cleared or not
-   * @memberof ClipboardActionProvider
+   * @returns True when successfully cleared, false otherwise
    */
   clear(): Promise<boolean>;
 
   /**
-   * copy should allow to copy text to the system's clipboard
+   * copy should allow to copy text to the systems clipboard
    *
-   * @param {string} text The text to copy to the clipboard
-   * @memberof ClipboardActionProvider
+   * @param text The text to copy to the clipboard
    */
   copy(text: string): Promise<void>;
 
   /**
-   * paste should allow to paste the current text on the system's clipboard
+   * paste should allow to paste the current text on the systems clipboard
    *
-   * @returns {Promise<string>} The current clipboard text
-   * @memberof ClipboardActionProvider
+   * @returns The current clipboard text
    */
   paste(): Promise<string>;
 }

Diff for: lib/provider/native/keyboard-action-provider.interface.ts

@@ -1,48 +1,41 @@
 import { Key } from "../../key.enum";
 
 /**
- * A KeyboardActionProvider should provide access to a system's keyboard
- *
- * @interface KeyboardActionProvider
+ * A KeyboardActionProvider should provide access to a systems keyboard
  */
 export interface KeyboardActionProvider {
   /**
    * setKeyboardDelay should allow to configure a delay between key presses
    *
-   * @param {number} delay The delay
-   * @memberof KeybaordActionProvider
+   * @param delay The delay between key presses in milliseconds
    */
   setKeyboardDelay(delay: number): void;
 
   /**
    * type should allow to type a given text via OS level keyboard events
    *
-   * @param {string} input The text to type
-   * @memberof KeyboardActionProvider
+   * @param input The text to type
    */
   type(input: string): Promise<void>;
 
   /**
    * Click should allow to press a single key via OS level keyboard event
    *
-   * @param {Key[]} keys The keys to click
-   * @memberof KeyboardActionProvider
+   * @param keys Array of {@link Key}s to click
    */
   click(...keys: Key[]): Promise<void>;
 
   /**
    * pressKey should allow to press and hold a key via OS level keyboard event
    *
-   * @param {Key[]} keys to press and hold
-   * @memberof KeyboardActionProvider
+   * @param keys Array of {@link Key}s to press and hold
    */
   pressKey(...keys: Key[]): Promise<void>;
 
   /**
    * releaseKey should release a pressed key via OS level keyboard event
    *
-   * @param {Key[]} keys to release
-   * @memberof KeyboardActionProvider
+   * @param keys Array of {@link Key}s to release
    */
   releaseKey(...keys: Key[]): Promise<void>;
 }

Diff for: lib/provider/native/mouse-action-provider.interface.ts

@@ -2,101 +2,84 @@ import { Button } from "../../button.enum";
 import { Point } from "../../point.class";
 
 /**
- * A MouseActionProvider should provide access to a system's mouse input
- *
- * @interface MouseActionInterface
+ * A MouseActionProvider should provide access to a systems mouse input
  */
 export interface MouseActionInterface {
   /**
    * setMouseDelay should allow to configure mouse movement speed
    *
-   * @param {number} delay The delay
-   * @memberof MouseActionInterface
+   * @param delay The delay in milliseconds
    */
   setMouseDelay(delay: number): void;
 
   /**
    * setMousePosition should allow to set the mouse cursor position
    *
-   * @param {Point} p The point to which the mouse pointer should be set
-   * @memberof MouseActionInterface
+   * @param p The {@link Point} to which the mouse pointer should be set
    */
   setMousePosition(p: Point): Promise<void>;
 
   /**
    * currentMousePosition should return the current mouse pointer position
    *
-   * @returns {Promise<Point>} The current mouse pointer position
-   * @memberof MouseActionInterface
+   * @returns The current mouse pointer position
    */
   currentMousePosition(): Promise<Point>;
 
   /**
    * leftClick should allow to perform a left click via OS event
-   *
-   * @memberof MouseActionInterface
    */
   leftClick(): Promise<void>;
 
   /**
    * rightClick should allow to perform a right click via OS event
-   *
-   * @memberof MouseActionInterface
    */
   rightClick(): Promise<void>;
 
   /**
    * middleClick should allow to perform a middle click via OS event
-   *
-   * @memberof MouseActionInterface
    */
   middleClick(): Promise<void>;
 
   /**
    * scrollUp should allow to perform an upward mouse scroll
    *
-   * @param {number} amount The scroll amount
-   * @memberof MouseActionInterface
+   * @param amount The scroll amount
    */
   scrollUp(amount: number): Promise<void>;
 
   /**
    * scrollDown should allow to perform an downward mouse scroll
    *
-   * @param {number} amount The scroll amount
-   * @memberof MouseActionInterface
+   * @param amount The scroll amount
    */
   scrollDown(amount: number): Promise<void>;
 
   /**
    * scrollLeft should allow to perform a left mouse scroll
    *
-   * @param {number} amount The scroll amount
-   * @memberof MouseActionInterface
+   * @param amount The scroll amount
    */
   scrollLeft(amount: number): Promise<void>;
 
   /**
    * scrollRight should perform a right mouse scroll
    *
-   * @param {number} amount The scroll amount
-   * @memberof MouseActionInterface
+   * @param amount The scroll amount
    */
   scrollRight(amount: number): Promise<void>;
 
   /**
    * pressButton should allow to press and hold a mouse button
    *
-   * @param {Button} btn The button to press and hold
-   * @memberof MouseActionInterface
+   * @param btn The {@link Button} to press and hold
    */
   pressButton(btn: Button): Promise<void>;
 
   /**
    * releaseButton should allow to release a pressed button
    *
-   * @param {Button} btn The button to release
-   * @memberof MouseActionInterface
+   * @param btn The {@link Button} to release
    */
   releaseButton(btn: Button): Promise<void>;
 }

Diff for: lib/provider/native/screen-action-provider.interface.ts

@@ -8,44 +8,39 @@ import { Region } from "../../region.class";
  */
 export interface ScreenActionProvider {
   /**
-   * grabScreen should return an Image object containing a screenshot data of a system's
+   * grabScreen should return an {@link Image} object containing a screenshot data of a systems
    * main screen as well as its dimensions
    *
-   * @returns {Promise<Image>} The Image object holding screenshot data
-   * @memberof ScreenActionProvider
+   * @returns The {@link Image} object holding screenshot data
    */
   grabScreen(): Promise<Image>;
 
   /**
    * Returns the same result as grabScreen, but limited to a specified region
    *
-   * @param {Region} region The region to take the screenshot of
-   * @returns {Promise<Image>} The Image object holding screenshot data
-   * @memberof ScreenActionProvider
+   * @param region The {@link Region} to take the screenshot of
+   * @returns The {@link Image} object holding screenshot data
    */
   grabScreenRegion(region: Region): Promise<Image>;
 
   /**
-   * screenWidth returns a system's main screen width
+   * screenWidth returns a systems main screen width
    *
-   * @returns {Promise<number>} The screen width
-   * @memberof ScreenActionProvider
+   * @returns The screen width
    */
   screenWidth(): Promise<number>;
 
   /**
-   * screenHeight returns a system's main screen height
+   * screenHeight returns a systems main screen height
    *
-   * @returns {Promise<number>} The screen height
-   * @memberof ScreenActionProvider
+   * @returns The screen height
    */
   screenHeight(): Promise<number>;
 
   /**
-   * screenSize returns a Region object the size of a system's main screen
+   * screenSize returns a {@link Region} object the size of a systems main screen
    *
-   * @returns {Promise<Region>} The Region object
-   * @memberof ScreenActionProvider
+   * @returns The {@link Region} object representing the screen dimensions
    */
   screenSize(): Promise<Region>;
 }