chore: Add dartdoc comments to public API

Author: lijy91

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 LiJianying <lijy91@foxmail.com>
+Copyright (c) 2023-2024 LiJianying <lijy91@foxmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README-ZH.md

@@ -47,7 +47,7 @@
 
 ```yaml
 dependencies:
-  shortcut_menu_extender: ^0.1.0
+  shortcut_menu_extender: ^0.1.1
 ```
 
 ### 用法

README.md

@@ -47,7 +47,7 @@ Add this to your package's pubspec.yaml file:
 
 ```yaml
 dependencies:
-  shortcut_menu_extender: ^0.1.0
+  shortcut_menu_extender: ^0.1.1
 ```
 
 ### Usage

analysis_options.yaml

@@ -1,3 +1,7 @@
+## 0.1.1
+
+* chore: Add dartdoc comments to public API
+
 ## 0.1.0
 
 * First release.

packages/shortcut_menu_extender/CHANGELOG.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 LiJianying <lijy91@foxmail.com>
+Copyright (c) 2023-2024 LiJianying <lijy91@foxmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

packages/shortcut_menu_extender/LICENSE

@@ -0,0 +1 @@
+include: package:mostly_reasonable_lints/flutter.yaml

packages/shortcut_menu_extender/analysis_options.yaml

@@ -1,28 +1 @@
-# This file configures the analyzer, which statically analyzes Dart code to
-# check for errors, warnings, and lints.
-#
-# The issues identified by the analyzer are surfaced in the UI of Dart-enabled
-# IDEs (https://dart.dev/tools#ides-and-editors). The analyzer can also be
-# invoked from the command line by running `flutter analyze`.
-
-# The following line activates a set of recommended lints for Flutter apps,
-# packages, and plugins designed to encourage good coding practices.
-include: package:flutter_lints/flutter.yaml
-
-linter:
-  # The lint rules applied to this project can be customized in the
-  # section below to disable rules from the `package:flutter_lints/flutter.yaml`
-  # included above or to enable additional rules. A list of all available lints
-  # and their documentation is published at https://dart.dev/lints.
-  #
-  # Instead of disabling a lint rule for the entire project in the
-  # section below, it can also be suppressed for a single line of code
-  # or a specific dart file by using the `// ignore: name_of_lint` and
-  # `// ignore_for_file: name_of_lint` syntax on the line or in the file
-  # producing the lint.
-  rules:
-    # avoid_print: false  # Uncomment to disable the `avoid_print` rule
-    # prefer_single_quotes: true  # Uncomment to enable the `prefer_single_quotes` rule
-
-# Additional information about this file can be found at
-# https://dart.dev/guides/language/analysis-options
+include: package:mostly_reasonable_lints/flutter.yaml

packages/shortcut_menu_extender/example/analysis_options.yaml

@@ -6,7 +6,6 @@
 // For more information about Flutter integration tests, please see
 // https://docs.flutter.dev/cookbook/testing/integration/introduction
 
-
 import 'package:flutter_test/flutter_test.dart';
 import 'package:integration_test/integration_test.dart';
 

packages/shortcut_menu_extender/example/integration_test/plugin_integration_test.dart

@@ -1,8 +1,8 @@
+import 'dart:async';
 import 'dart:io';
 
+import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
-import 'dart:async';
-
 import 'package:flutter/services.dart';
 import 'package:shortcut_menu_extender/shortcut_menu_extender.dart';
 
@@ -114,13 +114,15 @@ class _MyAppState extends State<MyApp> with ShortcutMenuListener {
               child: const Text('unregister 我的FlutterApp2'),
             ),
             Expanded(
-              child: ListView(children: [
-                for (final entity in _entities)
-                  ListTile(
-                    title: Text(entity.statSync().type.toString()),
-                    subtitle: Text(entity.path),
-                  ),
-              ]),
+              child: ListView(
+                children: [
+                  for (final entity in _entities)
+                    ListTile(
+                      title: Text(entity.statSync().type.toString()),
+                      subtitle: Text(entity.path),
+                    ),
+                ],
+              ),
             ),
           ],
         ),
@@ -139,7 +141,9 @@ class _MyAppState extends State<MyApp> with ShortcutMenuListener {
       }
       setState(() {});
     } else if (key == _kShortcutMenuKeyMyFlutterApp2) {
-      print('key: $key, path: $path');
+      if (kDebugMode) {
+        print('key: $key, path: $path');
+      }
     }
   }
 }