doc: 📝 Add more class level documentation

Author: aditya-css

lib/src/models/action_button_icon.dart

@@ -23,16 +23,32 @@ import 'package:flutter/cupertino.dart';
 import 'package:flutter/material.dart';
 
 class ActionButtonIcon {
+  /// Creates an icon configuration for a tooltip action button with a
+  /// standard [Icon].
+  ///
+  /// The [icon] parameter is required and specifies the icon to display.
+  /// The optional [padding] parameter defines spacing around the icon.
   const ActionButtonIcon({
     required Icon this.icon,
     this.padding,
   });
 
+  /// Creates an icon configuration for a tooltip action button with an
+  /// [ImageIcon].
+  ///
+  /// The [icon] parameter is required and specifies the image icon to display.
+  /// The optional [padding] parameter defines spacing around the icon.
   const ActionButtonIcon.withImageIcon({
     required ImageIcon this.icon,
     this.padding,
   });
 
+  /// The icon widget to display in the button.
+  ///
+  /// Can be either an [Icon] or [ImageIcon] depending on which constructor
+  /// is used.
   final Widget icon;
+
+  /// Optional padding to apply around the icon.
   final EdgeInsets? padding;
 }

lib/src/models/linked_showcase_data.dart

@@ -21,9 +21,10 @@
  */
 import 'package:flutter/widgets.dart';
 
-/// This model is used to move linked showcase overlay data to parent
-/// showcase to crop linked showcase rect
+@immutable
 class LinkedShowcaseDataModel {
+  /// This model is used to move linked showcase overlay data to parent
+  /// showcase to crop linked showcase rect.
   const LinkedShowcaseDataModel({
     required this.rect,
     required this.radius,

lib/src/models/showcase_scope.dart

@@ -25,6 +25,19 @@ import '../showcase/showcase_controller.dart';
 import '../showcase/showcase_view.dart';
 
 class ShowcaseScope {
+  /// A container class that manages showcase views within a specific named scope.
+  ///
+  /// This class is responsible for:
+  /// - Maintain a reference to a named scope and its associated [ShowcaseView].
+  /// - Store and organize [ShowcaseController] instances by their GlobalKeys.
+  /// - Enable multiple independent showcase systems to coexist in different
+  /// parts of the app.
+  /// - Facilitate proper routing of showcase events to the correct controllers.
+  ///
+  /// This class is primarily used by [ShowcaseService] to manage showcase
+  /// views and their controllers within different scopes, allowing for
+  /// isolated showcase experiences that can be independently controlled and
+  /// navigated.
   ShowcaseScope({
     required this.name,
     required this.showcaseView,

lib/src/models/tooltip_action_button.dart

@@ -24,75 +24,32 @@ import 'package:flutter/material.dart';
 import '../../showcaseview.dart';
 
 class TooltipActionButton {
-  /// To Provide Background color to the action
-  final Color? backgroundColor;
-
-  /// To Provide borderRadius to the action
-  ///
-  /// Defaults to const BorderRadius.all(Radius.circular(50)),
-  final BorderRadius? borderRadius;
-
-  /// To Provide textStyle to the action text
-  final TextStyle? textStyle;
-
-  /// To Provide padding to the action widget
-  ///
-  /// Defaults to const EdgeInsets.symmetric(horizontal: 15,vertical: 4,)
-  final EdgeInsets? padding;
-
-  /// To Provide a custom widget for the action in [TooltipActionButton.custom]
-  final Widget? button;
-
-  /// To Provide a leading icon for the action
-  final ActionButtonIcon? leadIcon;
-
-  /// To Provide a tail icon for the action
-  final ActionButtonIcon? tailIcon;
-
-  /// To Provide a action type
-  final TooltipDefaultActionType? type;
-
-  /// To Provide a text for action
-  ///
-  /// If type is provided then it will take type name
-  final String? name;
-
-  /// To Provide a onTap for action
-  ///
-  /// If type is provided then it will take type's OnTap
-  final VoidCallback? onTap;
-
-  /// To Provide a border for action
-  final Border? border;
-
-  /// Hides action widgets for the showcase. Add key of particular showcase
-  /// in this list.
-  /// This only works for the global action widgets
-  /// Defaults to []
-  final List<GlobalKey> hideActionWidgetForShowcase;
-
-  /// A configuration for a tooltip action button or Provide a custom tooltip action.
+  /// A configuration for a tooltip action button or Provide a custom tooltip
+  /// action.
   ///
   /// This class allows you to define predefined actions like "Next,"
   /// "Previous," and "Close," or specify a custom action widget.
   ///
   /// **Required arguments:**
   ///
-  /// - `type`: The type of the action button (e.g., `TooltipDefaultActionType.next`).
+  /// - `type`: The type of the action button (e.g.,
+  /// `TooltipDefaultActionType.next`).
   ///
   /// **Optional arguments:**
   ///
   /// - `backgroundColor`: The background color of the button
   /// - `textStyle`: The text style for the button label.
-  /// - `borderRadius`: The border radius of the button. Defaults to a rounded shape.
+  /// - `borderRadius`: The border radius of the button. Defaults to a
+  /// rounded shape.
   /// - `padding`: The padding around the button content.
   /// - `leadIcon`: An optional leading icon for the button.
   /// - `tailIcon`: An optional trailing icon for the button.
   /// - `name`: The text for the button label (ignored if `type` is provided).
   /// - `onTap`: A callback function triggered when the button is tapped.
   /// - `border`: A border to draw around the button.
-  /// - `hideActionWidgetForShowcase`: A list of `GlobalKey`s of showcases where this
-  /// action widget should be hidden. This only works for global action widgets.
+  /// - `hideActionWidgetForShowcase`: A list of `GlobalKey`s of showcases
+  /// where this action widget should be hidden. This only works for global
+  /// action widgets.
   const TooltipActionButton({
     required this.type,
     this.backgroundColor,
@@ -125,4 +82,51 @@ class TooltipActionButton {
         name = null,
         onTap = null,
         border = null;
+
+  /// To Provide Background color to the action
+  final Color? backgroundColor;
+
+  /// To Provide borderRadius to the action
+  ///
+  /// Defaults to const BorderRadius.all(Radius.circular(50)),
+  final BorderRadius? borderRadius;
+
+  /// To Provide textStyle to the action text
+  final TextStyle? textStyle;
+
+  /// To Provide padding to the action widget
+  ///
+  /// Defaults to const EdgeInsets.symmetric(horizontal: 15,vertical: 4,)
+  final EdgeInsets? padding;
+
+  /// To Provide a custom widget for the action in [TooltipActionButton.custom]
+  final Widget? button;
+
+  /// To Provide a leading icon for the action
+  final ActionButtonIcon? leadIcon;
+
+  /// To Provide a tail icon for the action
+  final ActionButtonIcon? tailIcon;
+
+  /// To Provide a action type
+  final TooltipDefaultActionType? type;
+
+  /// To Provide a text for action
+  ///
+  /// If type is provided then it will take type name
+  final String? name;
+
+  /// To Provide a onTap for action
+  ///
+  /// If type is provided then it will take type's OnTap
+  final VoidCallback? onTap;
+
+  /// To Provide a border for action
+  final Border? border;
+
+  /// Hides action widgets for the showcase. Add key of particular showcase
+  /// in this list.
+  /// This only works for the global action widgets
+  /// Defaults to []
+  final List<GlobalKey> hideActionWidgetForShowcase;
 }

lib/src/models/tooltip_action_config.dart

@@ -63,12 +63,13 @@ class TooltipActionConfig {
 
   /// Defines running direction alignment for the Action widgets.
   ///
-  /// Default to [crossAxisAlignment.start]
+  /// Default to [CrossAxisAlignment.start]
   final CrossAxisAlignment crossAxisAlignment;
 
   /// If aligning items according to their baseline, which baseline to use.
   ///
-  /// This must be set if using baseline alignment. There is no default because there is no
-  /// way for the framework to know the correct baseline _a priori_.
+  /// This must be set if using baseline alignment. There is no default
+  /// because there is no way for the framework to know the correct baseline
+  /// _a priori_.
   final TextBaseline? textBaseline;
 }