add description in gf animation

Author: deepikahr

lib/components/animation/gf_animation.dart

@@ -34,10 +34,10 @@ class GFAnimation extends StatefulWidget {
     this.reverseDuration,
   }) : super(key: key);
 
-  /// The duration for animations of the [Decoration].
+    /// `The duration for animation to perform`
   final Duration duration;
 
-  /// The duration for animations of the type[Size].
+  /// The duration for animation to perform
   final Duration reverseDuration;
 
   /// Defines how the animated widget is aligned within the Animation.
@@ -49,7 +49,7 @@ class GFAnimation extends StatefulWidget {
   /// The child of type [Widget] to display animation effect.
   final Widget child;
 
-  /// Determines the animation curve physics. Defaults to [Curves.linear].
+  /// Determines the animation curve. Defaults to [Curves.linear].
   final Curve curve;
 
   ///type of [GFAnimation] which takes the type ie, align, size, container, rotateTransition, scaleTransition, slideTransition, and textStyle for the [GFAnimation]
@@ -58,51 +58,66 @@ class GFAnimation extends StatefulWidget {
   /// [AnimatedContainer] initial width
   final double width;
 
-  /// [AnimatedContainer] changed width
+  /// defines the width of [AnimatedContainer] upto which it can extend during animation
   final double changedWidth;
 
   /// [AnimatedContainer] initial height
   final double height;
 
-  /// [AnimatedContainer] changed height
+  /// defines the height of [AnimatedContainer] upto which it can extend during animation
   final double changedHeight;
 
-  /// defines the color of items when onTap triggers
+  /// defines the color of [AnimatedContainer] when onTap triggers
   final Color activeColor;
 
-  /// defines the color of items
+  /// defines the color of [AnimatedContainer]
   final Color color;
 
-  /// The empty space that surrounds the animation. Defines the animation outer [Container.padding]..
+  /// defines [child]'s or [AnimatedContainer] padding
   final EdgeInsetsGeometry padding;
 
-  /// The empty space that surrounds the animation. Defines the animation outer [Container.margin].
+  /// defines [child]'s or [AnimatedContainer] margin
   final EdgeInsetsGeometry margin;
+
+  /// Called when the user taps the [child]
   final Function onTap;
 
   /// Here's an illustration of the [RotationTransition] widget, with it's [turnsAnimation]
-  /// animated by a [Tween] set to [animate]:
+  /// animated by a [stuckValue] set to [animate]
   final Animation<double> turnsAnimation;
 
   /// Here's an illustration of the [ScaleTransition] widget, with it's [scaleAnimation]
-  /// animated by a [CurvedAnimation] set to [Curves.linear]:
+  /// animated by a [CurvedAnimation] set to [Curves.linear]
   final Animation<double> scaleAnimation;
 
+  /// controls animation
   final AnimationController controller;
 
   ///direction of the [AnimatedDefaultTextStyle] TextDirection for [ltr,rtl]
   final TextDirection textDirection;
 
-  ///  * [ScaleTransition], which animates the scale of a widget.
+  /// [ScaleTransition], which animates the scale of a widget.
   final Animation<Offset> slidePosition;
+
+  /// defines the [TextStyle] of [AnimatedDefaultTextStyle]
   final TextStyle style;
+
+  /// defines the [TextAlign] of [AnimatedDefaultTextStyle]
   final TextAlign textAlign;
+
+  /// defines the [TextOverflow] of [AnimatedDefaultTextStyle]
   final TextOverflow textOverflow;
 
-  /// [AnimatedDefaultTextStyle] maxlines
+  /// defines the [maxLines] of [AnimatedDefaultTextStyle]
   final int maxLines;
+
+  /// defines the [TextWidthBasis] of [AnimatedDefaultTextStyle]
   final TextWidthBasis textWidthBasis;
+
+  /// defines the [fontSize] of [AnimatedDefaultTextStyle]
   final double fontSize;
+
+  /// defines the [fontWeight] of [AnimatedDefaultTextStyle]
   final FontWeight fontWeight;
 
   @override

lib/components/border/gf_border.dart

@@ -16,7 +16,7 @@ class GFBorder extends StatelessWidget {
   })  : assert(child != null),
         assert(_isValidDashedLine(dashedLine), 'Invalid dash pattern');
 
-  /// child of  type [Widget] which can be any component or text , etc
+  /// child of  type [Widget] which can be any component or text, etc
   final Widget child;
 
   /// padding of time [EdgeInsets] where in padding is given to the border types

lib/components/button/gf_button_bar.dart

@@ -45,7 +45,7 @@ class GFButtonBar extends StatelessWidget {
   ///    are placed relative to each other in the cross axis.
   final WrapAlignment alignment;
 
-  /// How much space to place between children in a run in the main axis.
+  /// How much space to place bestuckValue children in a run in the main axis.
   ///
   /// For example, if [spacing] is 10.0, the children will be spaced at least
   /// 10.0 logical pixels apart in the main axis.
@@ -73,7 +73,7 @@ class GFButtonBar extends StatelessWidget {
   ///    are placed relative to each other in the cross axis.
   final WrapAlignment runAlignment;
 
-  /// How much space to place between the runs themselves in the cross axis.
+  /// How much space to place bestuckValue the runs themselves in the cross axis.
   ///
   /// For example, if [runSpacing] is 10.0, the runs will be spaced at least
   /// 10.0 logical pixels apart in the cross axis.

lib/components/carousel/gf_carousel.dart

@@ -75,7 +75,7 @@ class GFCarousel extends StatefulWidget {
   /// Sets Duration to determent the frequency of slides when [autoPlay] is set to true. Defaults to 4 seconds.
   final Duration autoPlayInterval;
 
-  /// The animation duration between two transitioning pages while in auto playback. Defaults to 800 ms.
+  /// The animation duration bestuckValue two transitioning pages while in auto playback. Defaults to 800 ms.
   final Duration autoPlayAnimationDuration;
 
   /// Determines the animation curve physics. Defaults to [Curves.fastOutSlowIn].
@@ -344,7 +344,7 @@ class _GFCarouselState extends State<GFCarousel> with TickerProviderStateMixin {
 /// For example; We have a Carousel of 10000(simulating infinity) but only 6 images.
 /// We need to repeat the images to give the illusion of a never ending stream.
 /// By calling _getRealIndex with position and base we get an offset.
-/// This offset modulo our length, 6, will return a number between 0 and 5, which represent the image
+/// This offset modulo our length, 6, will return a number bestuckValue 0 and 5, which represent the image
 /// to be placed in the given position.
 int _getRealIndex(int position, int base, int length) {
   final int offset = position - base;

lib/components/image/gf_image_overlay.dart

@@ -67,9 +67,9 @@ class GFImageOverlay extends StatelessWidget {
   ///
   /// If this is [BoxShape.circle] then [borderRadius] is ignored.
   ///
-  /// The [shape] cannot be interpolated; animating between two [BoxDecoration]s
+  /// The [shape] cannot be interpolated; animating bestuckValue two [BoxDecoration]s
   /// with different [shape]s will result in a discontinuity in the rendering.
-  /// To interpolate between two shapes, consider using [ShapeDecoration] and
+  /// To interpolate bestuckValue two shapes, consider using [ShapeDecoration] and
   /// different [ShapeBorder]s; in particular, [CircleBorder] instead of
   /// [BoxShape.circle] and [RoundedRectangleBorder] instead of
   /// [BoxShape.rectangle].

lib/components/intro_screen/gf_intro_screen.dart

@@ -1,7 +1,5 @@
 import 'package:flutter/material.dart';
-import 'package:getwidget/components/intro_screen/gf_intro_bottom_navigation.dart';
-import 'package:getwidget/components/intro_screen/gf_intro_slide.dart';
-import 'package:getwidget/types/gf_intro_type.dart';
+import 'package:getwidget/getwidget.dart';
 
 class GFIntroScreen extends StatefulWidget {
   const GFIntroScreen(

lib/components/intro_screen/gf_intro_slide.dart

@@ -1,6 +1,5 @@
 import 'package:flutter/material.dart';
-import 'package:getwidget/colors/gf_color.dart';
-import 'package:getwidget/components/image/gf_image_overlay.dart';
+import 'package:getwidget/getwidget.dart';
 
 class GFIntroSlide extends StatelessWidget {
   const GFIntroSlide({
@@ -9,17 +8,38 @@ class GFIntroSlide extends StatelessWidget {
     this.image,
     this.title,
     this.subTitle,
+    this.subTitleText,
+    this.titleText,
     this.titleStyle = const TextStyle(fontSize: 20, color: GFColors.DARK),
     this.subTitleStyle = const TextStyle(fontSize: 16, color: GFColors.DARK),
     this.backgroundColor = GFColors.PRIMARY,
   }) : super(key: key);
 
+  /// defines [GFIntroSlide] [child], it takes nay widget
   final Widget child;
+
+  /// defines [GFIntroSlide] [image]
   final Image image;
-  final String title;
+
+  /// defines [title]'s text string
+  final String titleText;
+
+  /// defines [subTitle]'s text string
+  final String subTitleText;
+
+  /// defines [title]'s text string
+  final Text title;
+
+  /// defines [title]'s textStyle
   final TextStyle titleStyle;
-  final String subTitle;
+
+  /// defines [subTitle]'s text
+  final Text subTitle;
+
+  /// defines [subTitle]'s textStyle
   final TextStyle subTitleStyle;
+
+  /// defines [GFIntroSlide] backgroundColor
   final Color backgroundColor;
 
   @override
@@ -35,16 +55,16 @@ class GFIntroSlide extends StatelessWidget {
               height: 20,
             ),
             title != null ? Text(
-              title,
+              titleText,
               style: titleStyle,
-            ) : Container(),
+            ) : title,
             const SizedBox(
               height: 40,
             ),
             subTitle != null ? Text(
-              subTitle,
+              subTitleText,
               style: subTitleStyle,
-            ) : Container()
+            ) : subTitle
           ],
         ),
       );

lib/components/progress_bar/gf_progress_bar.dart

@@ -36,7 +36,7 @@ class GFProgressBar extends StatefulWidget {
 
     assert(circleStartAngle >= 0.0);
     if (percentage < 0.0 || percentage > 1.0) {
-      throw Exception('Percentage value must be between 0.0 and 1.0');
+      throw Exception('Percentage value must be be tween 0.0 and 1.0');
     }
   }
 
@@ -133,7 +133,7 @@ class _GFProgressBarState extends State<GFProgressBar>
           duration: Duration(milliseconds: widget.animationDuration),
           vsync: this);
       _animation =
-          Tween(begin: 0, end: widget.percentage).animate(_animationController)
+           Tween(begin: 0, end: widget.percentage).animate(_animationController)
             ..addListener(() {
               setState(() {
                 _progressPercent = _animation.value;
@@ -148,7 +148,7 @@ class _GFProgressBarState extends State<GFProgressBar>
       circularAnimationController = AnimationController(
           duration: Duration(milliseconds: widget.animationDuration),
           vsync: this);
-      circularAnimation = Tween(begin: 0, end: widget.percentage)
+      circularAnimation =  Tween(begin: 0, end: widget.percentage)
           .animate(circularAnimationController)
             ..addListener(() {
               setState(() {
@@ -191,7 +191,7 @@ class _GFProgressBarState extends State<GFProgressBar>
       if (_animationController != null) {
         _animationController.duration =
             Duration(milliseconds: widget.animationDuration);
-        _animation = Tween(
+        _animation =  Tween(
                 begin: widget.animateFromLastPercentage
                     ? oldWidget.percentage
                     : 0.0,
@@ -207,7 +207,7 @@ class _GFProgressBarState extends State<GFProgressBar>
       if (circularAnimationController != null) {
         circularAnimationController.duration =
             Duration(milliseconds: widget.animationDuration);
-        circularAnimation = Tween(
+        circularAnimation =  Tween(
                 begin: widget.animateFromLastPercentage
                     ? oldWidget.percentage
                     : 0.0,

lib/components/rating/gf_rating.dart

@@ -48,7 +48,7 @@ class GFRating extends StatefulWidget {
   /// defines the default items, when having filledIcon && halfFilledIcon
   final Widget defaultIcon;
 
-  /// defines the space between items
+  /// defines the space bestuckValue items
   final double spacing;
 
   /// defines the rating value