Merge pull request #43 from deepikahr/GFIntroScreen

Gf intro screen completed

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

@@ -14,9 +14,9 @@ class GFBorder extends StatelessWidget {
     this.radius = const Radius.circular(0),
     this.customPath,
   })  : assert(child != null),
-        assert(_isValiddashedLine(dashedLine), 'Invalid dash pattern');
+        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
@@ -61,7 +61,7 @@ class GFBorder extends StatelessWidget {
 }
 
 /// the value of dashedLine cannot be 0 or null, it should have some definite and proper value
-bool _isValiddashedLine(List<double> dash) {
+bool _isValidDashedLine(List<double> dash) {
   final Set<double> _dashSet = dash.toSet();
   if (_dashSet == null) {
     return false;

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/checkbox/gf_checkbox.dart

@@ -25,13 +25,13 @@ class GFCheckbox extends StatefulWidget {
       : assert(autofocus != null),
         super(key: key);
 
-  /// type of [GFCheckboxType] which is of four type is basic, sqaure, circular and custom
+  /// type of [GFCheckboxType] which is of four type is basic, square, circular and custom
   final GFCheckboxType type;
 
   /// type of [double] which is GFSize ie, small, medium and large and can use any double value
   final double size;
 
-  /// type pf [Color] used to change the checkcolor when the checkbox is active
+  /// type of [Color] used to change the checkcolor when the checkbox is active
   final Color checkColor;
 
   /// type of [Color] used to change the backgroundColor of the active checkbox
@@ -49,22 +49,23 @@ class GFCheckbox extends StatefulWidget {
   /// Called when the user checks or unchecks the checkbox.
   final ValueChanged<bool> onChanged;
 
-  ///Used to set the current state of the checkbox
+  /// Used to set the current state of the checkbox
   final bool value;
 
-  ///type of Widget used to change the  checkbox's active icon
+  /// type of [Widget] used to change the  checkbox's active icon
   final Widget activeIcon;
 
-  ///type of [Widget] used to change the  checkbox's inactive icon
+  /// type of [Widget] used to change the  checkbox's inactive icon
   final Widget inactiveIcon;
 
-  /// type of [Color] used to change the background color of the custom active  checkbox only
+  /// type of [Color] used to change the background color of the custom active checkbox only
   final Color custombgColor;
 
-  /// {@macro flutter.widgets.Focus.autofocus}
+  /// on true state this widget will be selected as the initial focus
+  /// when no other node in its scope is currently focused
   final bool autofocus;
 
-  /// {@macro flutter.widgets.Focus.focusNode}
+  /// an optional focus node to use as the focus node for this widget.
   final FocusNode focusNode;
 
   @override

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].