[fix] Add more docs comments, more description in pubspec.yaml, 0.1.0+1

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 [English](./CHANGELOG_en.md)
 
+## [0.1.0+1]
+
+* 增加一些 docs comment，修改 pubspec.yaml 的描述信息
+
 ## [0.1.0]
 
 * 开源

CHANGELOG_en.md

@@ -2,6 +2,10 @@
 
 [简体中文](./CHANGELOG.md)
 
+## [0.1.0+1]
+
+* Add some docs comments, modify description in pubspec.yaml.
+
 ## [0.1.0]
 
 * Open source.

lib/core/plugin_manager.dart

@@ -17,6 +17,7 @@ class PluginManager {
 
   PluginManager._();
 
+  /// Register a single [plugin]
   void register(Pluggable plugin) {
     if (plugin.name == null ||
         plugin.name.isEmpty ||
@@ -26,6 +27,7 @@ class PluginManager {
     _pluginsMap[plugin.name] = plugin;
   }
 
+  /// Register multiple [plugins]
   void registerAll(List<Pluggable> plugins) {
     for (final plugin in plugins) {
       assert(plugin is Pluggable);

lib/core/ui/root_widget.dart

@@ -23,6 +23,7 @@ const defaultLocalizationsDelegates = const [
   GlobalCupertinoLocalizations.delegate,
 ];
 
+/// Wrap your App widget. If [enable] is false, the function will return [child].
 Widget injectUMEWidget({
   @required Widget child,
   @required bool enable,

lib/util/store_mixin.dart

@@ -3,6 +3,7 @@ import 'package:shared_preferences/shared_preferences.dart';
 mixin StoreMixin {
   Future<SharedPreferences> _sharedPref = SharedPreferences.getInstance();
 
+  /// Store a object with the [key]. The [obj] must be one of [bool], [double], [int], [String] or [List]<String>.
   Future<void> storeWithKey(String key, dynamic obj) async {
     if (obj == null) {
       return;
@@ -22,6 +23,7 @@ mixin StoreMixin {
     }
   }
 
+  /// Fetch a object by the [key]
   Future<dynamic> fetchWithKey(String key) async {
     final SharedPreferences prefs = await _sharedPref;
     final savedKey = 'ume_${runtimeType.toString}_$key';

pubspec.yaml

@@ -1,6 +1,6 @@
 name: flutter_ume
-description: UME is an in-app debug kits platform for Flutter apps.
-version: 0.1.0
+description: UME is an in-app debug kits platform for Flutter apps. Produced by Flutter Infra team of ByteDance.
+version: 0.1.0+1
 homepage: https://github.com/bytedance/flutter_ume
 
 environment: