ConversionFlutter - 注释补充

lib/convert_flutter.dart

@@ -5,6 +5,7 @@ import 'package:flutter/cupertino.dart';
 import 'package:flutter/services.dart';
 import 'package:provider/provider.dart';
 
+///Use ‘EventChannel’ to communicate with Android\ios for file conversion.
 class ConvertFlutter {
   static const EventChannel _channel =
       EventChannel('com.compdfkit.conversion.flutter.convert');
@@ -15,19 +16,14 @@ class ConvertFlutter {
       String tag = result['dataTag'];
       int progress = result['progress'];
       int status = result['status'];
-      print('convert Flutter tag:$tag');
-      context
-          .read<ConvertProvider>()
-          .updateStatus(tag, progress, status, null);
+      context.read<ConvertProvider>().updateStatus(tag, progress, status, null);
 
       if (status == convertSuccess || status == convertFail) {
-        print("转档完成:状态:${status} , ${result['outputPath']}");
         context
             .read<ConvertProvider>()
             .updateStatus(tag, progress, status, result['outputPath']);
-        ConvertBean nextBean = context
-            .read<ConvertProvider>()
-            .getNextConvertBean();
+        ConvertBean nextBean =
+            context.read<ConvertProvider>().getNextConvertBean();
         convert(context, nextBean);
       }
     }, onDone: () {}, onError: (object) {});

lib/convert_sdk_info_flutter.dart

@@ -8,19 +8,16 @@ class ConvertSDKInfoFlutter{
   MethodChannel('com.compdfkit.conversion.flutter.convert.sdk.info');
 
 
-
+  ///get conversion sdk version info
   static Future<String> getConversionSDKVersion() async {
     var versionInfo = await _channel.invokeMethod('request_convert_sdk_version' );
     return versionInfo;
   }
 
+
   static Future<String> getOutputPath() async{
     var outPutPath = await _channel.invokeMethod('request_convert_output_path');
     return outPutPath;
   }
 
-
-
-
-
 }

lib/main.dart

@@ -51,8 +51,8 @@ class _MyHomePageState extends State<MyHomePage> {
           child: Column(
             crossAxisAlignment: CrossAxisAlignment.start,
             children: const <Widget>[
-              ConversionSdkInfoWidget(),
-              ConvertConfigWidget(),
+              ConversionSdkInfoWidget(),//conversion sdk info widget
+              ConvertConfigWidget(), //convert options widget,
               Expanded(child: ConvertListWidget())
             ],
           ),

lib/models/convert_contain_options_bean.dart

@@ -2,26 +2,27 @@ import 'package:ConversionFlutterDemo/models/convert_bean.dart';
 
 class ConvertOptionsBean {
 
-
+  //The 'containImage' parameter is used when converting to ppt, word, excel、rtf、html format
   bool containImages;
+  //The 'containImage' parameter is used when converting to ppt、word、excel、image、rtf、html format
   bool containAnnotations;
 
-  //convert excel only
+  //Only used when converting to excel
   ExcelWorkSheetOptions workSheetOptions;
 
-  //convert excel only
+  //Only used when converting to excel
   ContentOptions contentOptions = ContentOptions.AllContent;
 
-  //convert image only, 1~1000
+  //Only used when converting to image, the limited range is 1~1000
   int imageDpi = 300;
 
-  //convert image only
+  //Only used when converting to image
   ImagePageOptions imagePageOptions;
 
-  //convert csv only
+  //Only used when converting to csv
   bool mergeCSV = false;
 
-  //convert html only
+  //Only used when converting to html
   HtmlPageOptions htmlPageOptions;
 
   ConvertOptionsBean(
@@ -35,6 +36,13 @@ class ConvertOptionsBean {
       this.htmlPageOptions = HtmlPageOptions.SinglePage});
 
 
+  ///You do not need to pass all the parameters below. Please pass them according to the format of the conversion.
+  ///convert to ppt,word,rtf : containImages,containAnnotations
+  ///convert to excel : containImages, containAnnotations, workSheetOptions, contentOptions
+  ///convert to image : containAnnotations, imageDpi, imagePageOptions
+  ///convert to csv : mergeCSV
+  ///convert to html : containImages, containAnnotations, htmlPageOptions
+  ///
   Map<String, String> getOptions(ConvertBean bean) {
     return {
       'dataTag' : bean.tag,

lib/states/convert_options_provider.dart

@@ -3,6 +3,7 @@ import 'package:ConversionFlutterDemo/models/convert_type.dart';
 import 'package:ConversionFlutterDemo/widgets/options/convert_excel_options_widget.dart';
 import 'package:flutter/material.dart';
 
+///record convert format options
 class ConvertOptionsProvider extends ChangeNotifier {
   ConvertType convertType = ConvertType.none;
 
@@ -42,8 +43,6 @@ class ConvertOptionsProvider extends ChangeNotifier {
         return wordOptions;
       case ConvertType.excel:
         return excelOptions;
-      case ConvertType.txt:
-        return ConvertOptionsBean();
       case ConvertType.image:
         return imageOptions;
       case ConvertType.csv:

lib/widgets/convert_config.dart

@@ -69,11 +69,13 @@ class _ConvertConfigWidgetState extends State<ConvertConfigWidget> {
     );
   }
 
+  ///request storage permission
   Future<bool> getPermission() async {
     var status = await Permission.storage.request();
     return status.isGranted;
   }
 
+  ///Select pdf files from android\ios using 'file_picker'
   void getPDFFileList(BuildContext context) async {
     bool isGranted = await getPermission();
     if (!isGranted) {
@@ -81,7 +83,6 @@ class _ConvertConfigWidgetState extends State<ConvertConfigWidget> {
     }
     FilePickerResult? result =
         await FilePicker.platform.pickFiles(allowMultiple: true);
-
     if (result != null) {
       List<String?> files = result.paths;
       ConvertOptionsBean options =

lib/widgets/convert_type_options_widget.dart

@@ -1,2 +0,0 @@
-import 'package:flutter/material.dart';
-