add documentation

Author: renefloor

flutter_cache_manager/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [3.3.0] - 2021-11-29
+* Added option to manage the log level. Doesn't print failed downloads by default anymore. You can set it like this:
+```dart
+CacheManager.logLevel = CacheManagerLogLevel.verbose;
+```
+
 ## [3.2.0] - 2021-11-27
 * [Bugfix] getSingleFile now downloads a new file before completing as the outdated file might have been deleted.
 

flutter_cache_manager/example/lib/main.dart

@@ -12,6 +12,7 @@ void main() {
     pubDevURL: 'https://pub.dev/packages/flutter_cache_manager',
     pages: [CacheManagerPage.createPage()],
   ));
+  CacheManager.logLevel = CacheManagerLogLevel.verbose;
 }
 
 const url = 'https://blurha.sh/assets/images/img1.jpg';

flutter_cache_manager/lib/src/logger.dart

@@ -1,15 +1,20 @@
 import '../flutter_cache_manager.dart';
 
+/// Instance of the cache manager. Can be set to a custom one if preferred.
 CacheLogger cacheLogger = CacheLogger();
 
+/// Log levels of the cache manager. Debug shows failed downloads and verbose
+/// also shows successful downloads and cache retrievals.
 enum CacheManagerLogLevel {
   none,
   warning,
   debug,
   verbose,
 }
 
+/// [CacheLogger] which is used by the cache manager to log useful information
 class CacheLogger {
+  /// Function to log a message on a certain loglevel
   void log(String message, CacheManagerLogLevel level) {
     if (CacheManager.logLevel.index >= level.index) {
       print(message);

flutter_cache_manager/pubspec.yaml

@@ -1,6 +1,6 @@
 name: flutter_cache_manager
 description: Generic cache manager for flutter. Saves web files on the storages of the device and saves the cache info using sqflite.
-version: 3.2.0
+version: 3.3.0
 homepage: https://github.com/Baseflow/flutter_cache_manager/tree/master/flutter_cache_manager
 
 environment: