From db3d5b63c6945980aa334ad14ef3ee2d95055c2a Mon Sep 17 00:00:00 2001 From: Ibby Date: Fri, 14 Oct 2016 06:44:57 -0400 Subject: [PATCH] docs(image-picker): add interface docs --- src/plugins/imagepicker.ts | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/src/plugins/imagepicker.ts b/src/plugins/imagepicker.ts index 7347951b7..800167348 100644 --- a/src/plugins/imagepicker.ts +++ b/src/plugins/imagepicker.ts @@ -2,19 +2,23 @@ import { Cordova, Plugin } from './plugin'; export interface ImagePickerOptions { - // max images to be selected, defaults to 15. If this is set to 1, upon - // selection of a single image, the plugin will return it. + /** + * max images to be selected, defaults to 15. If this is set to 1, upon selection of a single image, the plugin will return it. + */ maximumImagesCount?: number; - // max width and height to allow the images to be. Will keep aspect - // ratio no matter what. So if both are 800, the returned image - // will be at most 800 pixels wide and 800 pixels tall. If the width is - // 800 and height 0 the image will be 800 pixels wide if the source - // is at least that wide. + /** + * Max width to allow images to be + */ width?: number; + /** + * Max height to allow images to be + */ height?: number; - // quality of resized image, defaults to 100 + /** + * Quality of images, defaults to 100 + */ quality?: number; } @@ -38,6 +42,8 @@ export interface ImagePickerOptions { * } * }, (err) => { }); * ``` + * @interfaces + * ImagePickerOptions */ @Plugin({ plugin: 'cordova-plugin-image-picker',