Add English documentation comments to all benchmark_cherrypick source files (adapters, scenarios, CLI, reporters, runner)

benchmark_cherrypick/lib/scenarios/universal_chain_module.dart

@@ -1,26 +1,47 @@
 import 'package:cherrypick/cherrypick.dart';
 import 'universal_service.dart';
 
+/// Enum to represent the DI registration/binding mode.
 enum UniversalBindingMode {
+  /// Singleton/provider binding.
   singletonStrategy,
+
+  /// Factory-based binding.
   factoryStrategy,
+
+  /// Async-based binding.
   asyncStrategy,
 }
 
+/// Enum to represent which scenario is constructed for the benchmark.
 enum UniversalScenario {
+  /// Single registration.
   register,
+  /// Chain of dependencies.
   chain,
+  /// Named registrations.
   named,
+  /// Child-scope override scenario.
   override,
+  /// Asynchronous chain scenario.
   asyncChain,
 }
 
+/// Test module that generates a chain of service bindings for benchmarking.
+///
+/// Configurable by chain count, nesting depth, binding mode, and scenario
+/// to support various DI performance tests (singleton, factory, async, etc).
 class UniversalChainModule extends Module {
+  /// Number of chains to create.
   final int chainCount;
+  /// Depth of each chain.
   final int nestingDepth;
+  /// How modules are registered (factory/singleton/async).
   final UniversalBindingMode bindingMode;
+  /// Which di scenario to generate (chained, named, etc).
   final UniversalScenario scenario;
 
+  /// Constructs a configured test DI module for the benchmarks.
   UniversalChainModule({
     required this.chainCount,
     required this.nestingDepth,
@@ -31,6 +52,7 @@ class UniversalChainModule extends Module {
   @override
   void builder(Scope currentScope) {
     if (scenario == UniversalScenario.asyncChain) {
+      // Generate async chain with singleton async bindings.
       for (var chainIndex = 0; chainIndex < chainCount; chainIndex++) {
         for (var levelIndex = 0; levelIndex < nestingDepth; levelIndex++) {
           final chain = chainIndex + 1;
@@ -56,15 +78,18 @@ class UniversalChainModule extends Module {
 
     switch (scenario) {
       case UniversalScenario.register:
+        // Simple singleton registration.
         bind<UniversalService>()
             .toProvide(() => UniversalServiceImpl(value: 'reg', dependency: null))
             .singleton();
         break;
       case UniversalScenario.named:
+        // Named factory registration for two distinct objects.
         bind<Object>().toProvide(() => UniversalServiceImpl(value: 'impl1')).withName('impl1');
         bind<Object>().toProvide(() => UniversalServiceImpl(value: 'impl2')).withName('impl2');
         break;
       case UniversalScenario.chain:
+        // Chain of nested services, with dependency on previous level by name.
         for (var chainIndex = 0; chainIndex < chainCount; chainIndex++) {
           for (var levelIndex = 0; levelIndex < nestingDepth; levelIndex++) {
             final chain = chainIndex + 1;

benchmark_cherrypick/lib/scenarios/universal_service.dart

@@ -1,10 +1,17 @@
 
+/// Base interface for any universal service in the benchmarks.
+///
+/// Represents an object in the dependency chain with an identifiable value
+/// and (optionally) a dependency on a previous service in the chain.
 abstract class UniversalService {
+  /// String ID for this service instance (e.g. chain/level info).
   final String value;
+  /// Optional reference to dependency service in the chain.
   final UniversalService? dependency;
   UniversalService({required this.value, this.dependency});
 }
 
+/// Default implementation for [UniversalService] used in service chains.
 class UniversalServiceImpl extends UniversalService {
   UniversalServiceImpl({required super.value, super.dependency});
 }