docs(screenshot): fix param names (#1686)

This commit is contained in:
Jan Piotrowski 2017-06-14 07:40:51 +02:00 committed by Ibby Hadeed
parent b52371b174
commit 2128703d8d

View File

@ -34,11 +34,11 @@ export class Screenshot extends IonicNativePlugin {
/** /**
* Takes screenshot and saves the image * Takes screenshot and saves the image
* *
* @param {string} format. Format can take the value of either 'jpg' or 'png' * @param format {string} Format can take the value of either 'jpg' or 'png'
* On ios, only 'jpg' format is supported * On ios, only 'jpg' format is supported
* @param {number} quality. Determines the quality of the screenshot. * @param quality {number} Determines the quality of the screenshot.
* Default quality is set to 100. * Default quality is set to 100.
* @param {string} filename. Name of the file as stored on the storage * @param filename {string} Name of the file as stored on the storage
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */
save(format?: string, quality?: number, filename?: string): Promise<any> { save(format?: string, quality?: number, filename?: string): Promise<any> {
@ -63,7 +63,7 @@ export class Screenshot extends IonicNativePlugin {
/** /**
* Takes screenshot and returns the image as an URI * Takes screenshot and returns the image as an URI
* *
* @param {number} quality. Determines the quality of the screenshot. * @param quality {number} Determines the quality of the screenshot.
* Default quality is set to 100. * Default quality is set to 100.
* @returns {Promise<any>} * @returns {Promise<any>}
*/ */