From 093a23145f4636a0af77d047638b21f9376deb4d Mon Sep 17 00:00:00 2001
From: ksenia312 <nikitina3619@gmail.com>
Date: Wed, 31 Jan 2024 22:34:41 +0100
Subject: [PATCH] doc(lib): comments for some API

---
 lib/src/platforms/android/models/nearby_device.dart   | 3 +++
 lib/src/platforms/android/nearby_android_service.dart | 4 ++++
 lib/src/platforms/ios/models/nearby_device.dart       | 3 +++
 lib/src/types/communication_channel_data.dart         | 4 ++++
 4 files changed, 14 insertions(+)

diff --git a/lib/src/platforms/android/models/nearby_device.dart b/lib/src/platforms/android/models/nearby_device.dart
index 72cdeed..2bd0441 100644
--- a/lib/src/platforms/android/models/nearby_device.dart
+++ b/lib/src/platforms/android/models/nearby_device.dart
@@ -134,6 +134,9 @@ class NearbyAndroidDevice extends NearbyDevice {
   }
 }
 
+///
+/// Implementation of [NearbyDeviceMapper] for Android.
+///
 class NearbyAndroidMapper implements NearbyDeviceMapper {
   @override
   List<NearbyDevice> mapToDeviceList(dynamic value) {
diff --git a/lib/src/platforms/android/nearby_android_service.dart b/lib/src/platforms/android/nearby_android_service.dart
index ff9b4d3..4a8a3a7 100644
--- a/lib/src/platforms/android/nearby_android_service.dart
+++ b/lib/src/platforms/android/nearby_android_service.dart
@@ -19,6 +19,10 @@ class NearbyAndroidService extends NearbyService {
     return _socketService.state;
   }
 
+  ///
+  /// The connection information of a Wi-Fi p2p group connection
+  /// from the socket service.
+  ///
   NearbyConnectionAndroidInfo? get connectionInfo {
     return _socketService.connectionInfo;
   }
diff --git a/lib/src/platforms/ios/models/nearby_device.dart b/lib/src/platforms/ios/models/nearby_device.dart
index 001afdf..cf48d71 100644
--- a/lib/src/platforms/ios/models/nearby_device.dart
+++ b/lib/src/platforms/ios/models/nearby_device.dart
@@ -69,6 +69,9 @@ class NearbyIOSDevice extends NearbyDevice {
   }
 }
 
+///
+/// Implementation of [NearbyDeviceMapper] for IOS.
+///
 class NearbyIOSMapper implements NearbyDeviceMapper {
   @override
   List<NearbyDevice> mapToDeviceList(dynamic value) {
diff --git a/lib/src/types/communication_channel_data.dart b/lib/src/types/communication_channel_data.dart
index e76719e..c8ad3c7 100644
--- a/lib/src/types/communication_channel_data.dart
+++ b/lib/src/types/communication_channel_data.dart
@@ -80,6 +80,10 @@ class NearbyAndroidCommunicationChannelData {
   /// Listener of events that come to the server.
   ///
   final ValueChanged<HttpRequest>? serverListener;
+
+  ///
+  /// The port on which the socket will be created.
+  ///
   final int port;
 
   @override