docs(camera): Add descriptions to CameraSource (#608)

ionic-team · Sep 15, 2021 · 294925b · 294925b
1 parent b5ac27d
commit 294925b
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 5 deletions.
diff --git a/camera/README.md b/camera/README.md
@@ -223,11 +223,11 @@ Request camera and photo album permissions
 
 #### CameraSource
 
-| Members      | Value                 |
-| ------------ | --------------------- |
-| **`Prompt`** | <code>'PROMPT'</code> |
-| **`Camera`** | <code>'CAMERA'</code> |
-| **`Photos`** | <code>'PHOTOS'</code> |
+| Members      | Value                 | Description                                                        |
+| ------------ | --------------------- | ------------------------------------------------------------------ |
+| **`Prompt`** | <code>'PROMPT'</code> | Prompts the user to select either the photo album or take a photo. |
+| **`Camera`** | <code>'CAMERA'</code> | Take a new photo using the camera.                                 |
+| **`Photos`** | <code>'PHOTOS'</code> | Pick an existing photo fron the gallery or photo album.            |
 
 
 #### CameraDirection

diff --git a/camera/src/definitions.ts b/camera/src/definitions.ts
@@ -221,8 +221,17 @@ export interface Photo {
 }
 
 export enum CameraSource {
+  /**
+   * Prompts the user to select either the photo album or take a photo.
+   */
   Prompt = 'PROMPT',
+  /**
+   * Take a new photo using the camera.
+   */
   Camera = 'CAMERA',
+  /**
+   * Pick an existing photo fron the gallery or photo album.
+   */
   Photos = 'PHOTOS',
 }