Remove nodoc

PlugFox · Feb 24, 2024 · 5dd71e7 · 5dd71e7
1 parent 0e3a1c4
commit 5dd71e7
Show file tree

Hide file tree

Showing 14 changed files with 1 addition and 100 deletions.
diff --git a/lib/src/client/message_stream.dart b/lib/src/client/message_stream.dart
@@ -1,11 +1,9 @@
 import 'dart:async';
 import 'dart:convert';
 
-/// {@nodoc}
 final Converter<String, Map<String, Object?>> _$jsonTextDecoder =
     const JsonDecoder().cast<String, Map<String, Object?>>();
 
-/// {@nodoc}
 final Converter<List<int>, Map<String, Object?>> _$jsonBytesDecoder =
     const Utf8Decoder().fuse<Map<String, Object?>>(
         const JsonDecoder().cast<String, Map<String, Object?>>());

diff --git a/lib/src/client/ws_client.dart b/lib/src/client/ws_client.dart
@@ -53,7 +53,6 @@ final class WebSocketClient implements IWebSocketClient {
       WebSocketConnectionManager(this);
 
   /// Current options.
-  /// {@nodoc}
   final WebSocketOptions _options;
 
   @override

diff --git a/lib/src/client/ws_client_base.dart b/lib/src/client/ws_client_base.dart
@@ -13,10 +13,8 @@ import 'package:ws/src/client/ws_interceptor.dart';
 import 'package:ws/src/util/constants.dart';
 import 'package:ws/src/util/logger.dart';
 
-/// {@nodoc}
 @internal
 abstract base class WebSocketClientBase implements IWebSocketClient {
-  /// {@nodoc}
   WebSocketClientBase({
     Iterable<String>? protocols,
     Iterable<WSInterceptor>? interceptors,
@@ -36,7 +34,6 @@ abstract base class WebSocketClientBase implements IWebSocketClient {
   bool get isClosed => _isClosed; // coverage:ignore-line
   bool _isClosed = false;
 
-  /// {@nodoc}
   @protected
   final List<String>? protocols;
 
@@ -47,7 +44,6 @@ abstract base class WebSocketClientBase implements IWebSocketClient {
   late final void Function(Object data) _onReceivedDataChain;
 
   /// Output stream of data from native WebSocket client.
-  /// {@nodoc}
   @protected
   final StreamController<Object> _dataController;
 
@@ -56,15 +52,13 @@ abstract base class WebSocketClientBase implements IWebSocketClient {
       WebSocketMessagesStream(_dataController.stream);
 
   /// Current ready state of the WebSocket connection.
-  /// {@nodoc}
   abstract final WebSocketReadyState readyState;
 
   @override
   WebSocketClientState get state => _state;
   WebSocketClientState _state;
 
   /// Output stream of state changes.
-  /// {@nodoc}
   @protected
   final StreamController<WebSocketClientState> _stateController;
 
@@ -111,7 +105,6 @@ abstract base class WebSocketClientBase implements IWebSocketClient {
     _stateController.close().ignore();
   }
 
-  /// {@nodoc}
   @protected
   void setState(
       WebSocketClientState Function(WebSocketClientState state) change) {
@@ -121,21 +114,18 @@ abstract base class WebSocketClientBase implements IWebSocketClient {
     info('WebSocketClient state changed to $newState');
   }
 
-  /// {@nodoc}
   @protected
   void onConnected(String url) {
     setState((_) => WebSocketClientState.open(url: url));
   }
 
   /// On data received callback.
-  /// {@nodoc}
   @protected
   void onReceivedData(Object? data) {
     if (data == null) return;
     _onReceivedDataChain(data);
   }
 
-  /// {@nodoc}
   @protected
   void onDisconnected(int? code, String? reason) {
     setState((_) => WebSocketClientState.closed(
@@ -145,7 +135,6 @@ abstract base class WebSocketClientBase implements IWebSocketClient {
   }
 
   /// Error callback.
-  /// {@nodoc}
   @protected
   void onError(Object error, StackTrace stackTrace) {}
 

diff --git a/lib/src/client/ws_client_fake.dart b/lib/src/client/ws_client_fake.dart
@@ -8,7 +8,6 @@ import 'package:ws/src/client/ws_client_interface.dart';
 import 'package:ws/src/client/ws_options.dart';
 
 // coverage:ignore-start
-/// {@nodoc}
 @internal
 IWebSocketClient $platformWebSocketClient(WebSocketOptions? options) =>
     WebSocketClientFake(protocols: options?.protocols);
@@ -29,7 +28,6 @@ final class WebSocketClientFake implements IWebSocketClient {
         _isClosed = false,
         _state = WebSocketClientState.initial();
 
-  /// {@nodoc}
   @visibleForTesting
   final List<String>? protocols;
 

diff --git a/lib/src/client/ws_client_js.dart b/lib/src/client/ws_client_js.dart
@@ -14,7 +14,6 @@ import 'package:ws/src/client/ws_options.dart';
 import 'package:ws/src/client/ws_options_js.dart';
 import 'package:ws/src/util/logger.dart';
 
-/// {@nodoc}
 @internal
 IWebSocketClient $platformWebSocketClient(WebSocketOptions? options) =>
     switch (options) {
@@ -36,42 +35,33 @@ IWebSocketClient $platformWebSocketClient(WebSocketOptions? options) =>
         ),
     };
 
-/// {@nodoc}
 @internal
 final class WebSocketClient$JS extends WebSocketClientBase {
-  /// {@nodoc}
   WebSocketClient$JS({
     super.interceptors,
     super.protocols,
     $WebSocketOptions$JS? options,
   }) : _options = options;
 
-  /// {@nodoc}
   final $WebSocketOptions$JS? _options;
 
   /// Native WebSocket client.
-  /// {@nodoc}
   html.WebSocket? _client;
 
   /// Blob codec for `Blob <-> List<int>` conversion.
-  /// {@nodoc}
   late final _BlobCodec _blobCodec = _BlobCodec();
 
   /// Binding to data from native WebSocket client.
   /// The subscription of [_communication] to [_controller].
-  /// {@nodoc}
   StreamSubscription<Object?>? _dataBindSubscription;
 
   /// Binding to error from native WebSocket client.
-  /// {@nodoc}
   StreamSubscription<html.Event>? _errorBindSubscription;
 
   /// Binding to close event from native WebSocket client.
-  /// {@nodoc}
   StreamSubscription<html.CloseEvent>? _closeBindSubscription;
 
   /// Ready state of the WebSocket client.
-  /// {@nodoc}
   @override
   WebSocketReadyState get readyState {
     final code = _client?.readyState;
@@ -211,12 +201,9 @@ final class WebSocketClient$JS extends WebSocketClientBase {
   }
 }
 
-/// {@nodoc}
 final class _BlobCodec {
-  /// {@nodoc}
   _BlobCodec();
 
-  /// {@nodoc}
   @internal
   html.Blob write(Object data) {
     switch (data) {
@@ -239,7 +226,6 @@ final class _BlobCodec {
     }
   }
 
-  /// {@nodoc}
   @internal
   FutureOr<Object> read(html.Blob blob) async {
     final completer = Completer<Object>();

diff --git a/lib/src/client/ws_client_vm.dart b/lib/src/client/ws_client_vm.dart
@@ -12,7 +12,6 @@ import 'package:ws/src/client/ws_options.dart';
 import 'package:ws/src/client/ws_options_vm.dart';
 import 'package:ws/src/util/logger.dart';
 
-/// {@nodoc}
 @internal
 IWebSocketClient $platformWebSocketClient(WebSocketOptions? options) =>
     switch (options) {
@@ -34,28 +33,23 @@ IWebSocketClient $platformWebSocketClient(WebSocketOptions? options) =>
         ),
     };
 
-/// {@nodoc}
 @internal
 final class WebSocketClient$VM extends WebSocketClientBase {
-  /// {@nodoc}
   WebSocketClient$VM({
     super.interceptors,
     super.protocols,
     $WebSocketOptions$VM? options,
   }) : _options = options;
 
-  /// {@nodoc}
   final $WebSocketOptions$VM? _options;
 
   /// Native WebSocket client.
-  /// {@nodoc}
   // Close it at a [disconnect] or [close] method.
   // ignore: close_sinks
   io.WebSocket? _client;
 
   /// Binding to data from native WebSocket client.
   /// The subscription of [_communication] to [_controller].
-  /// {@nodoc}
   StreamSubscription<Object?>? _dataBindSubscription;
 
   @override

diff --git a/lib/src/client/ws_options_common.dart b/lib/src/client/ws_options_common.dart
@@ -1,10 +1,8 @@
 import 'package:meta/meta.dart';
 import 'package:ws/src/client/ws_options.dart';
 
-/// {@nodoc}
 @internal
 final class $WebSocketOptions$Common extends WebSocketOptions {
-  /// {@nodoc}
   $WebSocketOptions$Common({
     super.connectionRetryInterval,
     super.protocols,

diff --git a/lib/src/client/ws_options_js.dart b/lib/src/client/ws_options_js.dart
@@ -7,7 +7,6 @@ import 'package:ws/src/client/ws_client_interface.dart';
 import 'package:ws/src/client/ws_interceptor.dart';
 import 'package:ws/src/client/ws_options.dart';
 
-/// {@nodoc}
 @internal
 WebSocketOptions $vmOptions({
   ConnectionRetryInterval? connectionRetryInterval,
@@ -30,7 +29,6 @@ WebSocketOptions $vmOptions({
   );
 }
 
-/// {@nodoc}
 @internal
 WebSocketOptions $jsOptions({
   ConnectionRetryInterval? connectionRetryInterval,
@@ -49,15 +47,13 @@ WebSocketOptions $jsOptions({
       interceptors: interceptors,
     );
 
-/// {@nodoc}
 @internal
 WebSocketOptions $selectorOptions({
   required WebSocketOptions Function() vm,
   required WebSocketOptions Function() js,
 }) =>
     js();
 
-/// {@nodoc}
 final class $WebSocketOptions$JS extends WebSocketOptions {
   /// {@macro ws_options_js}
   $WebSocketOptions$JS({
@@ -69,6 +65,5 @@ final class $WebSocketOptions$JS extends WebSocketOptions {
     bool? useBlobForBinary,
   }) : useBlobForBinary = useBlobForBinary ?? false;
 
-  /// {@nodoc}
   final bool useBlobForBinary;
 }
diff --git a/lib/src/client/ws_options_vm.dart b/lib/src/client/ws_options_vm.dart
@@ -6,7 +6,6 @@ import 'package:ws/src/client/ws_client_interface.dart';
 import 'package:ws/src/client/ws_interceptor.dart';
 import 'package:ws/src/client/ws_options.dart';
 
-/// {@nodoc}
 @internal
 WebSocketOptions $vmOptions({
   ConnectionRetryInterval? connectionRetryInterval,
@@ -39,7 +38,6 @@ WebSocketOptions $vmOptions({
 
 // coverage:ignore-start
 
-/// {@nodoc}
 @internal
 WebSocketOptions $jsOptions({
   ConnectionRetryInterval? connectionRetryInterval,
@@ -61,18 +59,15 @@ WebSocketOptions $jsOptions({
 
 // coverage:ignore-end
 
-/// {@nodoc}
 @internal
 WebSocketOptions $selectorOptions({
   required WebSocketOptions Function() vm,
   required WebSocketOptions Function() js,
 }) =>
     vm();
 
-/// {@nodoc}
 @internal
 final class $WebSocketOptions$VM extends WebSocketOptions {
-  /// {@nodoc}
   $WebSocketOptions$VM({
     super.connectionRetryInterval,
     super.protocols,

diff --git a/lib/src/manager/connection_manager.dart b/lib/src/manager/connection_manager.dart
@@ -6,30 +6,22 @@ import 'package:ws/src/client/state.dart';
 import 'package:ws/src/client/ws_client_interface.dart';
 import 'package:ws/src/util/logger.dart';
 
-/// {@nodoc}
 @internal
 final class WebSocketConnectionManager {
-  /// {@nodoc}
   WebSocketConnectionManager(IWebSocketClient client)
       : _client = WeakReference<IWebSocketClient>(client);
 
-  /// {@nodoc}
   final WeakReference<IWebSocketClient> _client;
 
-  /// {@nodoc}
   StreamSubscription<void>? _watcher;
 
-  /// {@nodoc}
   Timer? _timer;
 
-  /// {@nodoc}
   int? _attempt;
 
-  /// {@nodoc}
   DateTime? _nextReconnectionAttempt;
 
   /// Recive the current status of reconnection for the client.
-  /// {@nodoc}
   ({
     int attempt,
     bool active,
@@ -40,7 +32,6 @@ final class WebSocketConnectionManager {
         nextReconnectionAttempt: _nextReconnectionAttempt,
       );
 
-  /// {@nodoc}
   void startMonitoringConnection(
     String url,
     ({Duration max, Duration min})? connectionRetryInterval,
@@ -60,13 +51,11 @@ final class WebSocketConnectionManager {
         client.stateChanges.listen(stateChangesHandler, cancelOnError: false);
   }
 
-  /// {@nodoc}
   void stopMonitoringConnection() {
     _stopSubscription();
     _stopTimer();
   }
 
-  /// {@nodoc}
   void Function(WebSocketClientState state) _handleStateChange(
     IWebSocketClient client,
     String lastUrl,
@@ -125,7 +114,6 @@ final class WebSocketConnectionManager {
 
   /// Full jitter technique.
   /// https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
-  /// {@nodoc}
   @internal
   static Duration backoffDelay(int step, int minDelay, int maxDelay) {
     if (minDelay >= maxDelay) return Duration(milliseconds: maxDelay);
@@ -135,6 +123,5 @@ final class WebSocketConnectionManager {
   }
 
   /// Randomizer for full jitter technique.
-  /// {@nodoc}
   static final math.Random _rnd = math.Random();
 }