(#87) VisionAdapter API docs

Author: s1hofmann

Diff for: lib/adapter/vision.adapter.class.ts

@@ -10,13 +10,19 @@ import { TemplateMatchingFinder } from "../provider/opencv/template-matching-fin
 import { Region } from "../region.class";
 
 /**
- * OpenCVAdapter serves as an abstraction layer for all image based interactions.
+ * {@link VisionAdapter} serves as an abstraction layer for all image based interactions.
  *
  * This allows to provide a high level interface for image based actions,
- * whithout having to spread (possibly) multiple dependencies all over the code.
+ * without having to spread (possibly) multiple dependencies all over the code.
  * All actions which involve screenshots / images are bundled in this adapter.
  */
 export class VisionAdapter {
+  /**
+   * {@link VisionAdapter} class constructor
+   * @param finder A {@link FinderInterface} instance used for on-screen image detection (Default: {@link TemplateMatchingFinder})
+   * @param screen A {@link ScreenActionProvider} instance used to retrieve screen data (Default: {@link ScreenAction})
+   * @param dataSink A {@link DataSink} instance used to write output data to disk (Default: {@link ImageWriter})
+   */
   constructor(
     private finder: FinderInterface = new TemplateMatchingFinder(),
     private screen: ScreenActionProvider = new ScreenAction(),
@@ -25,34 +31,31 @@ export class VisionAdapter {
   }
 
   /**
-   * grabScreen will return an Image containing the current screen image
+   * {@link grabScreen} will return an {@link Image} containing the current screen image
    *
-   * @returns {Promise<Image>} Image will contain screenshot data as well as dimensions
-   * @memberof VisionAdapter
+   * @returns An {@link Image} which will contain screenshot data as well as dimensions
    */
   public grabScreen(): Promise<Image> {
     return this.screen.grabScreen();
   }
 
   /**
-   * grabScreenRegion essentially does the same as grabScreen, but only returns a specified Region
+   * {@link grabScreenRegion} essentially does the same as grabScreen, but only returns a specified {@link Region}
    *
-   * @param {Region} region The screen region we want to grab
-   * @returns {Promise<Image>} Image will contain screenshot data of the specified region as well as dimensions
-   * @memberof VisionAdapter
+   * @param region The screen {@link Region} we want to grab
+   * @returns An {@link Image} which will contain screenshot data of the specified {@link Region} as well as dimensions
    */
   public grabScreenRegion(region: Region): Promise<Image> {
     return this.screen.grabScreenRegion(region);
   }
 
   /**
-   * findOnScreenRegion will search for a given pattern inside a region of an image.
-   * If multiple possible occurences are found, the one with the highes probability is returned.
+   * {@link findOnScreenRegion} will search for a given pattern inside a {@link Region} of the main screen
+   * If multiple possible occurrences are found, the one with the highest probability is returned.
    * For matchProbability < 0.99 the search will be performed on grayscale images.
    *
-   * @param {MatchRequest} matchRequest A match request which holds all required matching data
-   * @returns {Promise<MatchResult>} MatchResult will contain location and probability of a possible match
-   * @memberof VisionAdapter
+   * @param matchRequest A {@link MatchRequest} which holds all required matching data
+   * @returns {@link MatchResult} containing location and probability of a possible match
    */
   public async findOnScreenRegion(
     matchRequest: MatchRequest,
@@ -68,47 +71,43 @@ export class VisionAdapter {
   }
 
   /**
-   * screenWidth returns the main screen's width as reported by the OS.
+   * {@link screenWidth} returns the main screens width as reported by the OS.
    * Please notice that on e.g. Apples Retina display the reported width
    * and the actual pixel size may differ
    *
-   * @returns {Promise<number>} The main screen's width as reported by the OS
-   * @memberof VisionAdapter
+   * @returns The main screens width as reported by the OS
    */
   public screenWidth(): Promise<number> {
     return this.screen.screenWidth();
   }
 
   /**
-   * screenHeight returns the main screen's height as reported by the OS.
+   * {@link screenHeight} returns the main screens height as reported by the OS.
    * Please notice that on e.g. Apples Retina display the reported width
    * and the actual pixel size may differ
    *
-   * @returns {Promise<number>} The main screen's height as reported by the OS
-   * @memberof VisionAdapter
+   * @returns The main screens height as reported by the OS
    */
   public screenHeight(): Promise<number> {
     return this.screen.screenHeight();
   }
 
   /**
-   * screenSize returns a Region object with the main screen's size.
-   * Please notice that on e.g. Apples Retina display the reported width
+   * {@link screenSize} returns a {@link Region} object with the main screens size.
+   * Please note that on e.g. Apples Retina display the reported width
    * and the actual pixel size may differ
    *
-   * @returns {Promise<Region>} The Region object the size of your main screen
-   * @memberof VisionAdapter
+   * @returns A {@link Region} object representing the size of a systems main screen
    */
   public screenSize(): Promise<Region> {
     return this.screen.screenSize();
   }
 
   /**
-   * saveImage saves an Image to a given path on disk.
+   * {@link saveImage} saves an {@link Image} to a given path on disk.
    *
-   * @param image The Image to store
-   * @param path The storage path
-   * @memberof VisionAdapter
+   * @param image The {@link Image} to store
+   * @param path The path where to store the image
    */
   public saveImage(image: Image, path: string): Promise<void> {
     return (this.dataSink as ImageWriter).store(image, path);