Merge pull request #182 from splitio/linter

Add linter rule for dartdoc comments

Author: EmilianoSanchez

splitio/analysis_options.yaml

@@ -2,3 +2,7 @@ include: package:flutter_lints/flutter.yaml
 
 # Additional information about this file can be found at
 # https://dart.dev/guides/language/analysis-options
+
+linter:
+  rules:
+    - public_member_api_docs

splitio/example/lib/main.dart

@@ -1,3 +1,5 @@
+// ignore_for_file: avoid_print
+
 import 'package:flutter/material.dart';
 import 'package:splitio/splitio.dart';
 

splitio/lib/split_client.dart

@@ -1,5 +1,6 @@
 import 'package:splitio_platform_interface/splitio_platform_interface.dart';
 
+/// Abstract class representing a Split client.
 abstract class SplitClient {
   /// Performs an evaluation for the [featureFlagName] feature flag.
   ///
@@ -187,11 +188,13 @@ abstract class SplitClient {
   Future<SplitClient> whenTimeout();
 }
 
+/// Default implementation of the Split client.
 class DefaultSplitClient implements SplitClient {
   final SplitioPlatform _platform;
   final String _matchingKey;
   final String? _bucketingKey;
 
+  /// Creates a new instance of the Split client.
   DefaultSplitClient(this._platform, this._matchingKey, this._bucketingKey);
 
   @override

splitio/lib/splitio.dart

@@ -15,8 +15,10 @@ export 'package:splitio_platform_interface/split_rollout_cache_configuration.dar
 export 'package:splitio_platform_interface/split_fallback_treatment.dart';
 export 'package:splitio_platform_interface/split_fallback_treatments_configuration.dart';
 
+/// Callback function type for client readiness events.
 typedef ClientReadinessCallback = void Function(SplitClient splitClient);
 
+/// Main class for interacting with the Split Flutter SDK.
 class Splitio {
   final String _sdkKey;
 
@@ -114,12 +116,14 @@ class Splitio {
     return client;
   }
 
+  /// Gets the list of all feature flag names.
   Future<List<String>> splitNames() async {
     List<String> splitNames = await _platform.splitNames();
 
     return splitNames;
   }
 
+  /// Gets the list of all feature flag views.
   Future<List<SplitView>> splits() async {
     return _platform.splits();
   }
@@ -130,14 +134,22 @@ class Splitio {
     return _platform.impressionsStream();
   }
 
+  /// Gets a specific feature flag view.
+  ///
+  /// Returns null if the provided feature flag name is not found.
   Future<SplitView?> split(String splitName) async {
     return _platform.split(splitName: splitName);
   }
 
+  /// Gets the user consent status.
   Future<UserConsent> getUserConsent() async {
     return _platform.getUserConsent();
   }
 
+  /// Sets the user consent status.
+  ///
+  /// [enabled] is a boolean that enables (`UserConsent.granted`)
+  /// or disables (`UserConsent.declined`) data collection.
   Future<void> setUserConsent(bool enabled) async {
     return _platform.setUserConsent(enabled);
   }

splitio_android/analysis_options.yaml

@@ -2,3 +2,7 @@ include: package:flutter_lints/flutter.yaml
 
 # Additional information about this file can be found at
 # https://dart.dev/guides/language/analysis-options
+
+linter:
+  rules:
+    - public_member_api_docs

splitio_ios/analysis_options.yaml

@@ -2,3 +2,7 @@ include: package:flutter_lints/flutter.yaml
 
 # Additional information about this file can be found at
 # https://dart.dev/guides/language/analysis-options
+
+linter:
+  rules:
+    - public_member_api_docs

splitio_platform_interface/analysis_options.yaml

@@ -2,3 +2,7 @@ include: package:flutter_lints/flutter.yaml
 
 # Additional information about this file can be found at
 # https://dart.dev/guides/language/analysis-options
+
+linter:
+  rules:
+    - public_member_api_docs

splitio_platform_interface/lib/events/split_method_call_handler.dart

@@ -2,6 +2,7 @@ import 'dart:async';
 
 import 'package:splitio_platform_interface/method_call_handler.dart';
 
+/// Handler for Split SDK events
 class SplitEventMethodCallHandler implements MethodCallHandler {
   static const String _eventClientReady = 'clientReady';
   static const String _eventClientReadyFromCache = 'clientReadyFromCache';
@@ -24,6 +25,7 @@ class SplitEventMethodCallHandler implements MethodCallHandler {
     _eventClientTimeout: false,
   };
 
+  /// Creates a new instance of the Split event method call handler.
   SplitEventMethodCallHandler(this._matchingKey, this._bucketingKey);
 
   @override
@@ -48,26 +50,32 @@ class SplitEventMethodCallHandler implements MethodCallHandler {
     }
   }
 
+  /// Returns Future that is completed when the SDK client is ready.
   Future<void> onReady() {
     return _onEvent(_eventClientReady);
   }
 
+  /// Returns Future that is completed when the SDK client is ready from cache.
   Future<void> onReadyFromCache() {
     return _onEvent(_eventClientReadyFromCache);
   }
 
+  /// Returns Stream that emits when the SDK client is updated.
   Stream<void> onUpdated() {
     return _updateStreamCompleter.stream;
   }
 
+  /// Returns Future that is completed when the SDK client times out.
   Future<void> onTimeout() {
     return _onEvent(_eventClientTimeout);
   }
 
+  /// Cleans up resources.
   void destroy() {
     _updateStreamCompleter.close();
   }
 
+  /// Returns Future that is completed when the specified SDK event occurs.
   Future<void> _onEvent(String sdkEvent) {
     if (_triggeredClientEvents.containsKey(sdkEvent) &&
         _triggeredClientEvents[sdkEvent] == true) {

splitio_platform_interface/lib/impressions/impressions_method_call_handler.dart

@@ -3,6 +3,7 @@ import 'dart:async';
 import 'package:splitio_platform_interface/method_call_handler.dart';
 import 'package:splitio_platform_interface/split_impression.dart';
 
+/// Handles impressions method calls.
 class ImpressionsMethodCallHandler extends StreamMethodCallHandler<Impression> {
   final _streamController = StreamController<Impression>();
 

splitio_platform_interface/lib/method_call_handler.dart

@@ -1,7 +1,11 @@
+/// Abstract class for handling method calls.
 abstract class MethodCallHandler {
+  /// Handles a method call with the given method name and arguments.
   Future<void> handle(String methodName, dynamic methodArguments);
 }
 
+/// Abstract class for handling stream method calls.
 abstract class StreamMethodCallHandler<T> extends MethodCallHandler {
+  /// Returns a stream of the given type.
   Stream<T> stream();
 }