dart doc comments

prahack · Jun 24, 2021 · 5b3141e · 5b3141e
1 parent b256bc5
commit 5b3141e
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## [0.0.3+1] - 16/06/2021.
+
+* dartdoc comments
+
 ## [0.0.3] - 11/06/2021.
 
 * null safety

diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# vimeo_player_flutter pugin
+# vimeo_player_flutter plugin
 
 vimeo_player_flutter plugin provides vimeo player Flutter widget based on the webview_flutter plugin.
 

diff --git a/example/pubspec.lock b/example/pubspec.lock
@@ -155,7 +155,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.0.2"
+    version: "0.0.3+1"
   webview_flutter:
     dependency: transitive
     description:

diff --git a/lib/vimeo_player_flutter.dart b/lib/vimeo_player_flutter.dart
@@ -5,12 +5,23 @@ import 'dart:convert';
 import 'package:flutter/material.dart';
 import 'package:webview_flutter/webview_flutter.dart';
 
+///vimeo player for Flutter apps
+///Flutter plugin based on the [webview_flutter] plugin
+///[videoId] is the only required field to use this plugin
+///
+///
+///
+///
 class VimeoPlayer extends StatelessWidget {
   final String videoId;
 
+  ///constructor
+  ///
+  ///
+  ///
   const VimeoPlayer({
-    Key key,
-    this.videoId,
+    Key? key,
+    required this.videoId,
   }) : super(key: key);
 
   @override
@@ -21,6 +32,11 @@ class VimeoPlayer extends StatelessWidget {
     );
   }
 
+  ///web page containing iframe of the vimeo video
+  ///
+  ///
+  ///
+  ///
   String _videoPage(String videoId) {
     final html = '''
             <html>

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: vimeo_player_flutter
-description: Vimeo Player Flutter package.
-version: 0.0.3
+description: Vimeo Player Flutter package for Flutter apps. Compatible with both iOS and Android platforms.
+version: 0.0.3+1
 homepage: https://github.com/prahack/vimeo_player
 
 environment: