docs: add more dartdoc comments to the public API

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [1.0.0+1] - 20-08-2020.
+
+- Added more dartdoc comments to the public API.
+
 ## [1.0.0] - 20-08-2020.
 
 - Initial release.

lib/src/banner/flavor_banner.dart

@@ -4,6 +4,7 @@ import 'package:flavor_config/src/config/flavor_config.dart';
 import 'package:flavor_config/src/dialog/device_info_dialog.dart';
 
 class FlavorBanner extends StatelessWidget {
+  /// The child where the banner should be rendered on top of.
   final Widget child;
 
   FlavorBanner({

lib/src/config/flavor_config.dart

@@ -1,9 +1,16 @@
 import 'package:flutter/material.dart';
 
 class FlavorConfig {
+  /// The name of the flavor.
   final String flavorName;
+
+  /// Determains if the banner should be shown.
   final bool bannerEnabled;
+
+  /// The color of the banner if enabled.
   final Color color;
+
+  /// The values that belong to the flavor.
   final Map<String, dynamic> values;
 
   static FlavorConfig _instance;
@@ -35,9 +42,18 @@ class FlavorConfig {
     this.values,
   );
 
+  /// Gets the name of the flavor.
   static String getFlavorName() => _instance.flavorName;
+
+  /// Returns `true` if the banner will be shown.
   static bool isBannerEnabled() => _instance.bannerEnabled;
+
+  /// Gets the color of the banner if enabled.
   static Color getColor() => _instance.color;
+
+  /// Gets the values that belong to the flavor.
   static Map<String, dynamic> getValues() => _instance.values;
+
+  /// Gets a value given a key.
   static dynamic getValue(String key) => _instance.values[key];
 }

lib/src/utils/device_utils.dart

@@ -7,6 +7,7 @@ enum BuildMode {
 }
 
 class DeviceUtils {
+  /// Returns the current build mode.
   static BuildMode currentBuildMode() {
     if (const bool.fromEnvironment('dart.vm.product')) {
       return BuildMode.RELEASE;
@@ -23,12 +24,14 @@ class DeviceUtils {
     return result;
   }
 
+  /// Returns a [Future] resolving into [AndroidDeviceInfo].
   static Future<AndroidDeviceInfo> androidDeviceInfo() async {
     final plugin = DeviceInfoPlugin();
 
     return plugin.androidInfo;
   }
 
+  /// Returns a [Future] resolving into [IosDeviceInfo].
   static Future<IosDeviceInfo> iosDeviceInfo() async {
     final plugin = DeviceInfoPlugin();
 

pubspec.yaml

@@ -1,6 +1,6 @@
 name: flavor_config
 description: An easy to use package for creating flavors for any environment.
-version: 1.0.0
+version: 1.0.0+1
 homepage: https://github.com/zino-hofmann/flavor-config-flutter
 
 environment: