From 294925b5a3ae40236e824d2f3ee18368e3d134d7 Mon Sep 17 00:00:00 2001 From: jcesarmobile Date: Wed, 15 Sep 2021 14:08:59 +0200 Subject: [PATCH] docs(camera): Add descriptions to CameraSource (#608) --- camera/README.md | 10 +++++----- camera/src/definitions.ts | 9 +++++++++ 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/camera/README.md b/camera/README.md index 5c26e6876..7126902be 100644 --- a/camera/README.md +++ b/camera/README.md @@ -223,11 +223,11 @@ Request camera and photo album permissions #### CameraSource -| Members | Value | -| ------------ | --------------------- | -| **`Prompt`** | 'PROMPT' | -| **`Camera`** | 'CAMERA' | -| **`Photos`** | 'PHOTOS' | +| Members | Value | Description | +| ------------ | --------------------- | ------------------------------------------------------------------ | +| **`Prompt`** | 'PROMPT' | Prompts the user to select either the photo album or take a photo. | +| **`Camera`** | 'CAMERA' | Take a new photo using the camera. | +| **`Photos`** | 'PHOTOS' | Pick an existing photo fron the gallery or photo album. | #### CameraDirection diff --git a/camera/src/definitions.ts b/camera/src/definitions.ts index 7571f2feb..0d675aef9 100644 --- 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', }