Merge pull request #3 from merixstudio/feature/doc

Add documentation

Author: mateusztylman

lib/mrx_charts.dart

@@ -1,3 +1,5 @@
+library mrx_charts;
+
 export 'src/chart.dart';
 export 'src/models/animation/chart_animation.dart';
 export 'src/models/axis/chart_axis_layer.dart';
@@ -19,5 +21,5 @@ export 'src/models/touchable/arc_shape.dart';
 export 'src/models/touchable/rectangle_shape.dart';
 export 'src/models/touchable/touchable_shape.dart';
 export 'src/painter/chart_painter.dart';
+export 'src/touch/chart_touch_callback_data.dart';
 export 'src/touch/chart_touch_detector.dart';
-export 'src/touch/stock_touch_callback_data.dart';

lib/src/chart.dart

@@ -3,12 +3,22 @@ import 'package:mrx_charts/src/models/chart_layer.dart';
 import 'package:mrx_charts/src/models/touchable/touchable_shape.dart';
 import 'package:mrx_charts/src/painter/chart_painter.dart';
 import 'package:mrx_charts/src/touch/chart_touch_detector.dart';
-import 'package:mrx_charts/src/touch/stock_touch_callback_data.dart';
+import 'package:mrx_charts/src/touch/chart_touch_callback_data.dart';
 import 'package:flutter/material.dart';
 
+/// Widget of charts.
 class Chart extends StatefulWidget {
+  /// The duration of the chart animations.
+  ///
+  /// Defaults to Duration(milliseconds: 300)
   final Duration duration;
+
+  /// The layers of charts.
   final List<ChartLayer> layers;
+
+  /// The padding of charts.
+  ///
+  /// Defaults to EdgeInsets.zero
   final EdgeInsets padding;
 
   const Chart({

lib/src/models/animation/chart_animation.dart

@@ -6,6 +6,7 @@ part 'chart_position_animation.dart';
 part 'chart_size_animation.dart';
 part 'chart_text_style_animation.dart';
 
+/// Abstract class for animation.
 abstract class ChartAnimation {
   void dispose();
 }

lib/src/models/animation/chart_color_animation.dart

@@ -1,20 +1,29 @@
 part of 'chart_animation.dart';
 
+/// Provides color animation values.
 class ChartColorAnimation implements ChartAnimation {
   Animation<Color?>? _animation;
   Color _lastColor = Colors.transparent;
 
   ChartColorAnimation();
 
+  /// Current value during the animation.
+  ///
+  /// Defaults to Colors.transparent
   Color get current => _lastColor = _animation?.value ?? Colors.transparent;
 
+  /// Last value on finish/stop animation.
+  ///
+  /// Defaults to Colors.transparent
   Color get last => _lastColor;
 
+  /// Dispose animation.
   @override
   void dispose() {
     _animation = null;
   }
 
+  /// Initialize animation.
   void setup({
     required Color color,
     required AnimationController controller,

lib/src/models/animation/chart_double_animation.dart

@@ -1,20 +1,29 @@
 part of 'chart_animation.dart';
 
+/// Provides double animation values.
 class ChartDoubleAnimation implements ChartAnimation {
   Animation<double>? _animation;
   double _lastValue = 0.0;
 
   ChartDoubleAnimation();
 
+  /// Current value during the animation.
+  ///
+  /// Defaults to 0.0
   double get current => _lastValue = _animation?.value ?? 0.0;
 
+  /// Last double value on finish/stop animation.
+  ///
+  /// Defaults to 0.0
   double get last => _lastValue;
 
+  /// Dispose animation.
   @override
   void dispose() {
     _animation = null;
   }
 
+  /// Initialize animation.
   void setup({
     required AnimationController controller,
     required double value,

lib/src/models/animation/chart_position_animation.dart

@@ -1,20 +1,29 @@
 part of 'chart_animation.dart';
 
+/// Provides position animation values.
 class ChartPositionAnimation implements ChartAnimation {
   Animation<Offset>? _animation;
   Offset _lastPosition = Offset.zero;
 
   ChartPositionAnimation();
 
+  /// Current value during the animation.
+  ///
+  /// Defaults to Offset.zero
   Offset get current => _lastPosition = _animation?.value ?? Offset.zero;
 
+  /// Last value on finish/stop animation.
+  ///
+  /// Defaults to Offset.zero
   Offset get last => _lastPosition;
 
+  /// Dispose animation.
   @override
   void dispose() {
     _animation = null;
   }
 
+  /// Initialize animation.
   void setup({
     required AnimationController controller,
     required Offset position,

lib/src/models/animation/chart_size_animation.dart

@@ -1,20 +1,29 @@
 part of 'chart_animation.dart';
 
+/// Provides size animation values.
 class ChartSizeAnimation implements ChartAnimation {
   Animation<Size>? _animation;
   Size _lastSize = Size.zero;
 
   ChartSizeAnimation();
 
+  /// Current value during the animation.
+  ///
+  /// Defaults to Size.zero
   Size get current => _lastSize = _animation?.value ?? Size.zero;
 
+  /// Last value on finish/stop animation.
+  ///
+  /// Defaults to Size.zero
   Size get last => _lastSize;
 
+  /// Dispose animation.
   @override
   void dispose() {
     _animation = null;
   }
 
+  /// Initialize animation.
   void setup({
     required AnimationController controller,
     required Size size,

lib/src/models/animation/chart_text_style_animation.dart

@@ -1,5 +1,6 @@
 part of 'chart_animation.dart';
 
+/// Provides text style animation values.
 class ChartTextStyleAnimation implements ChartAnimation {
   Animation<TextStyle>? _animation;
   TextStyle _lastTextStyle = const TextStyle(
@@ -8,18 +9,26 @@ class ChartTextStyleAnimation implements ChartAnimation {
 
   ChartTextStyleAnimation();
 
+  /// Current value during the animation.
+  ///
+  /// Defaults to TextStyle(color: Colors.transparent)
   TextStyle get current => _lastTextStyle = _animation?.value ??
       const TextStyle(
         color: Colors.transparent,
       );
 
+  /// Last value on finish/stop animation.
+  ///
+  /// Defaults to TextStyle(color: Colors.transparent)
   TextStyle get last => _lastTextStyle;
 
+  /// Dispose animation.
   @override
   void dispose() {
     _animation = null;
   }
 
+  /// Initialize animation.
   void setup({
     required AnimationController controller,
     required TextStyle textStyle,

lib/src/models/axis/chart_axis_layer.dart

@@ -7,9 +7,15 @@ part 'data/chart_axis_data_item.dart';
 part 'settings/chart_axis_settings.dart';
 part 'settings/chart_axis_settings_axis.dart';
 
+/// This layer allows to render axises.
 class ChartAxisLayer extends ChartLayer {
+  /// The x of the axis.
   final ChartAxisData x;
+
+  /// The y of the axis.
   final ChartAxisData y;
+
+  /// The settings of the axis.
   final ChartAxisSettings settings;
 
   ChartAxisLayer({
@@ -23,6 +29,7 @@ class ChartAxisLayer extends ChartLayer {
           label: labelY,
         );
 
+  /// Disposing all animations.
   @override
   void dispose() {
     x.dispose();

lib/src/models/axis/data/chart_axis_data.dart

@@ -1,8 +1,14 @@
 part of '../chart_axis_layer.dart';
 
+/// Providing datas of the selected axis.
 class ChartAxisData {
+  /// The items data of axis.
   final List<ChartAxisDataItem> items;
+
+  /// The max value in the data.
   final double max;
+
+  /// The min value in the data.
   final double min;
 
   ChartAxisData({
@@ -11,6 +17,7 @@ class ChartAxisData {
     required this.min,
   });
 
+  /// Disposing all animations.
   void dispose() {
     for (final ChartAxisDataItem item in items) {
       item.dispose();