From b665d4f7b5ac63a9fcffa4b5c86062dfa81c1680 Mon Sep 17 00:00:00 2001
From: bin <17426470+boyan01@users.noreply.github.com>
Date: Tue, 30 May 2023 12:18:06 +0800
Subject: [PATCH] [mixin_logger] bump version to 0.0.6

---
 packages/mixin_logger/CHANGELOG.md          |  4 ++++
 packages/mixin_logger/lib/mixin_logger.dart | 10 ++++++++++
 packages/mixin_logger/pubspec.yaml          |  6 +++---
 3 files changed, 17 insertions(+), 3 deletions(-)

diff --git a/packages/mixin_logger/CHANGELOG.md b/packages/mixin_logger/CHANGELOG.md
index e34d9428..1e1e9748 100644
--- a/packages/mixin_logger/CHANGELOG.md
+++ b/packages/mixin_logger/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 0.0.6
+
+* add `setLoggerFileLeading` api.
+
 ## 0.0.5
 
 * support config new log file content leading.
diff --git a/packages/mixin_logger/lib/mixin_logger.dart b/packages/mixin_logger/lib/mixin_logger.dart
index e93d706b..b8eee51f 100644
--- a/packages/mixin_logger/lib/mixin_logger.dart
+++ b/packages/mixin_logger/lib/mixin_logger.dart
@@ -84,26 +84,35 @@ Future<void> initLogger(
   await platform.initLogger(logDir, maxFileCount, maxFileLength, fileLeading);
 }
 
+/// Set the leading of log file content, it will be written
+/// to the first line of each log file.
 void setLoggerFileLeading(String? leading) {
   platform.setLoggerFileLeading(leading);
 }
 
+/// verbose log
 void v(String message) {
   _print(message, _LogLevel.verbose);
 }
 
+/// debug log
 void d(String message) {
   _print(message, _LogLevel.debug);
 }
 
+/// info log
 void i(String message) {
   _print(message, _LogLevel.info);
 }
 
+/// warning log
 void w(String message) {
   _print(message, _LogLevel.warning);
 }
 
+/// error log
+/// [error] the error object
+/// [stackTrace] the stack trace of the error
 void e(String message, [Object? error, StackTrace? stackTrace]) {
   var messageWithStack = message;
   if (error != null) {
@@ -115,6 +124,7 @@ void e(String message, [Object? error, StackTrace? stackTrace]) {
   _print(messageWithStack, _LogLevel.error);
 }
 
+/// wtf log
 void wtf(String message) {
   _print(message, _LogLevel.wtf);
 }
diff --git a/packages/mixin_logger/pubspec.yaml b/packages/mixin_logger/pubspec.yaml
index f1dc91d4..0f902649 100644
--- a/packages/mixin_logger/pubspec.yaml
+++ b/packages/mixin_logger/pubspec.yaml
@@ -1,10 +1,10 @@
 name: mixin_logger
-description: Simple logger tool for flutter.
-version: 0.0.5
+description: Simple logger tool for flutter, make it easy to save your app log to file.
+version: 0.0.6
 homepage: https://github.com/MixinNetwork/flutter-plugins
 
 environment:
-  sdk: ">=2.14.0 <3.0.0"
+  sdk: ">=2.14.0 <4.0.0"
   flutter: ">=1.17.0"
 
 dependencies: