Update to version 1.1.1+1

klydra · Aug 13, 2023 · dc82b8d · dc82b8d
1 parent 4d75297
commit dc82b8d
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -29,4 +29,10 @@
 
 ## 1.1.1
 
-* Add proper integration for Android API 30 and up using the new ```registerScanResultsCallback()``` function
+* Add proper integration for Android API 30 and up using the new ```registerScanResultsCallback()``` function
+
+## 1.1.1+1
+
+* Update README on pub.dev
+* Bump lints version
+* Add documentation comments
diff --git a/example/pubspec.lock b/example/pubspec.lock
@@ -71,10 +71,10 @@ packages:
     dependency: "direct dev"
     description:
       name: lints
-      sha256: a2c3d198cb5ea2e179926622d433331d8b58374ab8f29cdda6e863bd62fd369c
+      sha256: "0a217c6c989d21039f1498c3ed9f3ed71b354e69873f13a8dfc3c9fe76f1b452"
       url: "https://pub.dev"
     source: hosted
-    version: "1.0.1"
+    version: "2.1.1"
   matcher:
     dependency: transitive
     description:
@@ -174,7 +174,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "1.1.1"
+    version: "1.1.2"
 sdks:
-  dart: ">=3.0.0-0 <4.0.0"
+  dart: ">=3.0.0 <4.0.0"
   flutter: ">=1.20.0"
diff --git a/example/pubspec.yaml b/example/pubspec.yaml
@@ -15,7 +15,7 @@ dependencies:
 dev_dependencies:
   flutter_test:
     sdk: flutter
-  lints: ^1.0.1
+  lints: ^2.1.1
 
 flutter:
   uses-material-design: true
diff --git a/lib/wifi_hunter.dart b/lib/wifi_hunter.dart
@@ -5,8 +5,10 @@ import 'package:flutter/services.dart';
 import 'package:wifi_hunter/wifi_hunter_result.dart';
 
 class WiFiHunter {
+  /// Method channel to communicate with the native Android Java functions
   static const MethodChannel _channel = MethodChannel('wifi_hunter');
 
+  /// Start WiFi Scan
   static Future<WiFiHunterResult?> get huntWiFiNetworks async {
     final Map<String, dynamic> networks = Map<String, dynamic>.from(await _channel.invokeMethod('huntWiFiNetworks'));
 

diff --git a/lib/wifi_hunter_result.dart b/lib/wifi_hunter_result.dart
@@ -1,14 +1,25 @@
 class WiFiHunterResult {
+  /// List of WiFi networks in scan result
   List<WiFiHunterResultEntry> results = <WiFiHunterResultEntry>[];
 }
 
 class WiFiHunterResultEntry {
+  /// SSID (Wi-Fi Service Set Identifier) of the WiFi
   String ssid;
+  /// BSSID (Basic Service Set Identifier) of the WiFi
   String bssid;
+  /// Capabilities (supported standards) of the WiFi
   String capabilities;
+  /// Frequency (2.4GHz / 5GHz / 6GHz / ...) of the WiFi
+  /// Reference : https://developer.android.com/reference/android/net/wifi/ScanResult#constants_1
   int frequency;
+  /// Level (signal strength in dbm) of the WiFi
   int level;
+  /// Channel Width (20MHz / 40MHz / 80MHz / ...) of the WiFi
+  /// Reference : https://developer.android.com/reference/android/net/wifi/ScanResult#constants_1
   int channelWidth;
+  /// Timestamp of the WiFi scan (in microseconds since boot)
+  /// Reference : https://developer.android.com/reference/android/net/wifi/ScanResult#timestamp
   int timestamp;
 
   WiFiHunterResultEntry(this.ssid, this.bssid, this.capabilities, this.frequency, this.level, this.channelWidth, this.timestamp);

diff --git a/pubspec.lock b/pubspec.lock
@@ -71,10 +71,10 @@ packages:
     dependency: "direct dev"
     description:
       name: lints
-      sha256: a2c3d198cb5ea2e179926622d433331d8b58374ab8f29cdda6e863bd62fd369c
+      sha256: "0a217c6c989d21039f1498c3ed9f3ed71b354e69873f13a8dfc3c9fe76f1b452"
       url: "https://pub.dev"
     source: hosted
-    version: "1.0.1"
+    version: "2.1.1"
   matcher:
     dependency: transitive
     description:
@@ -169,5 +169,5 @@ packages:
     source: hosted
     version: "2.1.4"
 sdks:
-  dart: ">=3.0.0-0 <4.0.0"
+  dart: ">=3.0.0 <4.0.0"
   flutter: ">=1.20.0"
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,6 +1,6 @@
 name: wifi_hunter
 description: A flutter package to hunt down info from all WiFi APs around you.
-version: 1.1.1
+version: 1.1.1+1
 homepage: https://github.com/klydra/wifi_hunter
 repository: https://github.com/klydra/wifi_hunter.git
 
@@ -15,7 +15,7 @@ dependencies:
 dev_dependencies:
   flutter_test:
     sdk: flutter
-  lints: ^1.0.1
+  lints: ^2.1.1
 
 flutter:
   plugin: