docs(document-picker): fix docs

This commit is contained in:
Daniel 2018-04-08 21:20:35 +02:00
parent fc9add88dc
commit 4ab4aaf178

View File

@ -1,14 +1,12 @@
import { Injectable } from '@angular/core'; import { Injectable } from '@angular/core';
import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core'; import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
/** /**
* @name iOS DocumentPicker * @name iOS DocumentPicker
* @description * @description
* *
* Opens the file picker on iOS for the user to select a file, returns a file URI. * Opens the file picker on iOS for the user to select a file, returns a file URI.
* Allows the user to upload files from icloud * Allows the user to upload files from iCloud
* *
* @usage * @usage
* ```typescript * ```typescript
@ -33,13 +31,13 @@ import { Cordova, Plugin, IonicNativePlugin } from '@ionic-native/core';
}) })
@Injectable() @Injectable()
export class DocumentPicker extends IonicNativePlugin { export class DocumentPicker extends IonicNativePlugin {
/** /**
* Open a file * Open a file
* @param {string} filters files between 'image', 'pdf' or 'all' * @param {string} [option] files between 'image', 'pdf' or 'all'
* @returns {Promise<string>} * @returns {Promise<string>}
*/ */
@Cordova() @Cordova()
getFile(options?: string): Promise<string> { return; } getFile(option?: string): Promise<string> {
return;
}
} }