Added Documentation for Classes

Author: shariarunix

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## 1.0.3
+- Added Documentation for Classes
+
 ## 1.0.2
 - `isBreakPointEnabled` parameter of `Sdpify` constructor is now `true` by default.
 

lib/src/builder.dart

@@ -5,6 +5,10 @@ part of '../sdpify.dart';
 ///
 typedef SdpifyBuilder = Widget Function(BuildContext);
 
+/// [Sdpify] is the main entrypoint of this package
+/// [Sdpify] takes [SdpifyBuilder] method in constructor parameter
+/// which returns a [Widget] also takes [isBreakPointEnabled] bool value
+///
 class Sdpify extends StatelessWidget {
   /// [screenType] is static variable for global access
   /// It can Access like [Sdpify.screenType] this

lib/src/device_constant.dart

@@ -1,19 +1,56 @@
 part of '../sdpify.dart';
 
+/// [DeviceConstant] is a static class that defines popular screen widths
+/// and their respective scale ratios for adaptive UI scaling.
+///
 class DeviceConstant {
   DeviceConstant._();
 
+  /// [smallMobileWidth] The width of small mobile devices (e.g., older phones).
+  ///
   static const double smallMobileWidth = 320.0;
+
+  /// [mobileWidth] The width of standard mobile devices.
+  ///
   static const double mobileWidth = 375.0;
+
+  /// [largeMobileWidth] The width of large mobile devices.
+  ///
   static const double largeMobileWidth = 480.0;
+
+  /// [extraLargeMobileWidth] The width of extra-large mobile devices or small tablets.
+  ///
   static const double extraLargeMobileWidth = 600.0;
+
+  /// [tabletWidth] The width of tablets.
+  ///
   static const double tabletWidth = 768.0;
-  static const double desktopWidth = 1024;
 
+  /// [desktopWidth] The width of desktop devices.
+  ///
+  static const double desktopWidth = 1024.0;
+
+  /// [smallMobileScale] Scale ratio for small mobile devices.
+  ///
   static const double smallMobileScale = 0.90;
+
+  /// [mobileScale] Scale ratio for standard mobile devices.
+  ///
   static const double mobileScale = 0.95;
-  static const double largeMobileScale = 1;
+
+  /// [largeMobileScale] Scale ratio for large mobile devices.
+  ///
+  static const double largeMobileScale = 1.0;
+
+  /// [extraLargeMobileScale] Scale ratio for extra-large mobile devices.
+  ///
   static const double extraLargeMobileScale = 1.05;
+
+  /// [tabletScale] Scale ratio for tablets.
+  ///
   static const double tabletScale = 1.15;
+
+  /// [desktopScale] Scale ratio for desktop devices.
+  ///
   static const double desktopScale = 1.2;
 }

lib/src/extension.dart

@@ -1,6 +1,9 @@
 part of '../sdpify.dart';
 
 extension SdpifyExtension on num {
+  /// [sdp] is the main extension [Sdpify]
+  /// provides it takes normal logical pixel or any num units and scale them as dp
+  ///
   double get sdp {
     return this * Config().scaleFactor;
   }

lib/src/screen_type.dart

@@ -1,6 +1,11 @@
 part of '../sdpify.dart';
 
+/// [ScreenType] is an enum class which contains type of the device screens
+///
 enum ScreenType {
+  /// [undefined] Defines
+  /// when [Config] struggles to retrieve device [ScreenType]
+  ///
   undefined,
 
   /// [small] Defines for

pubspec.yaml

@@ -1,6 +1,6 @@
 name: sdpify
-description: "Sdpify is a lightweight package that provides Scalable Density Pixels (SDP) to ensure a consistent UI across different screen sizes and densities. It dynamically converts pixel-based values (px) into scalable dp (sdp), making your app adaptive and responsive on all devices."
-version: 1.0.2
+description: "Sdpify is a lightweight package that converts pixels to scalable dp (sdp), ensuring a responsive and consistent UI across all screen sizes and densities"
+version: 1.0.3
 
 repository: https://github.com/shariarunix/Sdpify
 homepage: https://github.com/shariarunix/Sdpify