From 8e68ab0b311c73551e6bfbb4d0bea35727ba884a Mon Sep 17 00:00:00 2001 From: Miguel Ruivo Date: Thu, 6 Dec 2018 16:05:10 +0000 Subject: [PATCH] adds comments for public API --- CHANGELOG.md | 6 +++++- lib/file_picker.dart | 2 ++ pubspec.yaml | 2 +- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 91e9d69..834a476 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,8 @@ -## 1.0.0 +## 1.0.1 + + * Adds comments for public API + +## 1.0.1 * **Version 1.0** release. * Adds support for ANY and VIDEO files. diff --git a/lib/file_picker.dart b/lib/file_picker.dart index 97002ae..c722e9d 100644 --- a/lib/file_picker.dart +++ b/lib/file_picker.dart @@ -3,6 +3,7 @@ import 'dart:async'; import 'package:flutter/services.dart'; import 'package:image_picker/image_picker.dart'; +/// Supported file types, [ANY] should be used if the file you need isn't listed enum FileType { ANY, PDF, @@ -22,6 +23,7 @@ class FilePicker { return image?.path; } + /// Returns a [String] with the absolute path for the selected file static Future getFilePath({FileType type = FileType.ANY}) async { switch (type) { case FileType.IMAGE: diff --git a/pubspec.yaml b/pubspec.yaml index 4629c3d..42c5d84 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,6 +1,6 @@ name: file_picker description: A plugin that allows you to pick absolute paths from diferent file types. -version: 1.0.0 +version: 1.0.1 author: Miguel Ruivo homepage: https://github.com/miguelpruivo/plugins_flutter_file_picker