Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added missing dartdoc to classes #148

Merged
merged 3 commits into from
Nov 6, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lib/animated_text_kit.dart
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/// _Animated Text Kit_ is a library of some cool and awesome text animations.
library animated_text_kit;

export 'src/typer.dart';
Expand Down
4 changes: 4 additions & 0 deletions lib/src/colorize.dart
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
import 'package:flutter/material.dart';
import 'dart:async';

/// Animation that displays [text] elements, shimmering transition between [colors].
///
/// ![colorize example](https://raw.githubusercontent.com/aagarwal1012/Animated-Text-Kit/master/display/colorize.gif)
class ColorizeAnimatedTextKit extends StatefulWidget {
/// List of [String] that would be displayed subsequently in the animation.
final List<String> text;
Expand Down Expand Up @@ -88,6 +91,7 @@ class ColorizeAnimatedTextKit extends StatefulWidget {
assert(null != isRepeatingAnimation),
super(key: key);

/// Creates the mutable state for this widget. See [StatefulWidget.createState].
@override
_ColorizeTextState createState() => _ColorizeTextState();
}
Expand Down
4 changes: 4 additions & 0 deletions lib/src/fade.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ import 'dart:async';
import 'dart:math';
import 'package:flutter/material.dart';

/// Animation that displays [text] elements, fading them in and then out.
///
/// ![fade example](https://raw.githubusercontent.com/aagarwal1012/Animated-Text-Kit/master/display/fade.gif)
class FadeAnimatedTextKit extends StatefulWidget {
/// List of [String] that would be displayed subsequently in the animation.
final List<String> text;
Expand Down Expand Up @@ -104,6 +107,7 @@ class FadeAnimatedTextKit extends StatefulWidget {
assert(null != isRepeatingAnimation),
super(key: key);

/// Creates the mutable state for this widget. See [StatefulWidget.createState].
@override
_FadeTextState createState() => _FadeTextState();
}
Expand Down
4 changes: 4 additions & 0 deletions lib/src/rotate.dart
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
import 'dart:async';
import 'package:flutter/material.dart';

/// Animation that displays [text] elements, rotating them in one at a time.
///
/// ![rotate example](https://raw.githubusercontent.com/aagarwal1012/Animated-Text-Kit/master/display/rotate.gif)
class RotateAnimatedTextKit extends StatefulWidget {
/// List of [String] that would be displayed subsequently in the animation.
final List<String> text;
Expand Down Expand Up @@ -108,6 +111,7 @@ class RotateAnimatedTextKit extends StatefulWidget {
assert(null != isRepeatingAnimation),
super(key: key);

/// Creates the mutable state for this widget. See [StatefulWidget.createState].
@override
_RotatingTextState createState() => _RotatingTextState();
}
Expand Down
4 changes: 4 additions & 0 deletions lib/src/scale.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ import 'dart:async';
import 'dart:math';
import 'package:flutter/material.dart';

/// Animation that displays [text] elements, scaling them up and then out, one at a time.
///
/// ![scale example](https://raw.githubusercontent.com/aagarwal1012/Animated-Text-Kit/master/display/scale.gif)
class ScaleAnimatedTextKit extends StatefulWidget {
/// List of [String] that would be displayed subsequently in the animation.
final List<String> text;
Expand Down Expand Up @@ -111,6 +114,7 @@ class ScaleAnimatedTextKit extends StatefulWidget {
assert(null != stopPauseOnTap),
super(key: key);

/// Creates the mutable state for this widget. See [StatefulWidget.createState].
@override
_ScaleTextState createState() => _ScaleTextState();
}
Expand Down
11 changes: 8 additions & 3 deletions lib/src/text_liquid_fill.dart
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import 'dart:math';
import 'package:flutter/material.dart';

/// Animation that displays a [text] element, coloring it to look like sloshing
/// water is filling it up.
///
/// ![TextLiquidFill example](https://raw.githubusercontent.com/aagarwal1012/Animated-Text-Kit/master/display/text_liquid_fill.gif)
class TextLiquidFill extends StatefulWidget {
/// Gives [TextStyle] to the text string.
///
Expand Down Expand Up @@ -68,6 +72,7 @@ class TextLiquidFill extends StatefulWidget {
assert(null != waveColor),
super(key: key);

/// Creates the mutable state for this widget. See [StatefulWidget.createState].
@override
_TextLiquidFillState createState() => _TextLiquidFillState();
}
Expand Down Expand Up @@ -126,7 +131,7 @@ class _TextLiquidFillState extends State<TextLiquidFill>
animation: _waveController,
builder: (BuildContext context, Widget child) {
return CustomPaint(
painter: WavePainter(
painter: _WavePainter(
textKey: _textKey,
waveAnimation: _waveController,
percentValue: _loadValue.value,
Expand Down Expand Up @@ -164,15 +169,15 @@ class _TextLiquidFillState extends State<TextLiquidFill>
}
}

class WavePainter extends CustomPainter {
class _WavePainter extends CustomPainter {
final _pi2 = 2 * pi;
final GlobalKey textKey;
final Animation<double> waveAnimation;
final double percentValue;
final double boxHeight;
final Color waveColor;

WavePainter({
_WavePainter({
@required this.textKey,
this.waveAnimation,
this.percentValue,
Expand Down
5 changes: 5 additions & 0 deletions lib/src/typer.dart
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ import 'dart:math';
import 'package:characters/characters.dart';
import 'package:flutter/material.dart';

/// Animation that displays [text] elements, as if they are being typed one
/// character at a time.
///
/// ![typer example](https://raw.githubusercontent.com/aagarwal1012/Animated-Text-Kit/master/display/typer.gif)
class TyperAnimatedTextKit extends StatefulWidget {
/// List of [String] that would be displayed subsequently in the animation.
final List<String> text;
Expand Down Expand Up @@ -88,6 +92,7 @@ class TyperAnimatedTextKit extends StatefulWidget {
assert(null != stopPauseOnTap),
super(key: key);

/// Creates the mutable state for this widget. See [StatefulWidget.createState].
@override
_TyperState createState() => _TyperState();
}
Expand Down
5 changes: 5 additions & 0 deletions lib/src/typewriter.dart
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ import 'dart:math';
import 'package:characters/characters.dart';
import 'package:flutter/material.dart';

/// Animation that displays [text] elements, as if they are being typed one
/// character at a time. Similar to [TyperAnimatedTextKit], but shows a cursor.
///
/// ![typewriter example](https://raw.githubusercontent.com/aagarwal1012/Animated-Text-Kit/master/display/typewriter.gif)
class TypewriterAnimatedTextKit extends StatefulWidget {
/// List of [String] that would be displayed subsequently in the animation.
final List<String> text;
Expand Down Expand Up @@ -103,6 +107,7 @@ class TypewriterAnimatedTextKit extends StatefulWidget {
assert(null != isRepeatingAnimation),
super(key: key);

/// Creates the mutable state for this widget. See [StatefulWidget.createState].
@override
_TypewriterState createState() => _TypewriterState();
}
Expand Down
7 changes: 5 additions & 2 deletions lib/src/wavy.dart
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@ import 'dart:async';
import 'dart:math' as math;
import 'package:flutter/material.dart';

/// Animation that displays [text] elements, with each text animated with its
/// characters popping like a stadium wave.
///
/// ![Wavy example](https://raw.githubusercontent.com/aagarwal1012/Animated-Text-Kit/master/display/wavy.gif)
class WavyAnimatedTextKit extends StatefulWidget {
const WavyAnimatedTextKit({
Key key,
Expand Down Expand Up @@ -59,14 +63,13 @@ class WavyAnimatedTextKit extends StatefulWidget {
/// By default it is set to true.
final bool isRepeatingAnimation;

/// Creates the mutable state for this widget. See [StatefulWidget.createState].
@override
_WavyAnimatedTextKitState createState() => _WavyAnimatedTextKitState();
}

class _WavyAnimatedTextKitState extends State<WavyAnimatedTextKit>
with TickerProviderStateMixin {
// List<GlobalKey<_WTextState>> _keys;

AnimationController _controller;
Animation<double> _waveAnim;
Timer _timer;
Expand Down