update doc

Author: kuczynski-merix

lib/src/chart.dart

@@ -8,7 +8,7 @@ import 'package:flutter/material.dart';
 
 /// Widget of charts.
 class Chart extends StatefulWidget {
-  /// The duration animation of charts.
+  /// The duration of the chart animations.
   ///
   /// Defaults to Duration(milliseconds: 300)
   final Duration duration;

lib/src/models/axis/chart_axis_layer.dart

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

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

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

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

@@ -1,6 +1,6 @@
 part of '../chart_axis_layer.dart';
 
-/// Provides data item of the axis.
+/// A collection of values for an axis in a chart.
 class ChartAxisDataItem {
   /// The label of data item.
   final String label;
@@ -37,7 +37,7 @@ class ChartAxisDataItem {
   /// Defaults to TextStyle(color: Colors.transparent)
   TextStyle get lastTextStyle => _textStyle.last;
 
-  /// Dispose all animations.
+  /// Disposing all animations.
   void dispose() {
     _pos.dispose();
     _textStyle.dispose();

lib/src/models/axis/settings/chart_axis_settings.dart

@@ -1,11 +1,11 @@
 part of '../chart_axis_layer.dart';
 
-/// Provides settings of axis.
+/// A collection of values for settings in axises.
 class ChartAxisSettings {
-  /// The x of axis.
+  /// The x of the axis.
   final ChartAxisSettingsAxis x;
 
-  /// The y of axis.
+  /// The y of the axis.
   final ChartAxisSettingsAxis y;
 
   const ChartAxisSettings({

lib/src/models/axis/settings/chart_axis_settings_axis.dart

@@ -1,14 +1,14 @@
 part of '../chart_axis_layer.dart';
 
-/// Provides settings of the selected axis.
+/// A collection of values for settings of the selected axis.
 class ChartAxisSettingsAxis {
   /// The frequency of the value.
   final double frequency;
 
-  /// The max of the value in axis.
+  /// The max of the value in the axis.
   final double max;
 
-  /// The min of the value in axis.
+  /// The min of the value in the axis.
   final double min;
 
   /// The TextStyle in axis.

lib/src/models/bar/chart_bar_data_item.dart

@@ -1,6 +1,6 @@
 part of 'chart_bar_layer.dart';
 
-/// Provides data item of bar.
+/// A collection of values for a single bar in a chart.
 class ChartBarDataItem extends ChartDataItem {
   /// The color of data item.
   final Color color;
@@ -71,7 +71,7 @@ class ChartBarDataItem extends ChartDataItem {
   /// Defaults to Size.zero
   Size get lastValueSize => _value.lastSize;
 
-  /// Dispose all animations.
+  /// Disposing all animations.
   @override
   void dispose() {
     _touch.dispose();
@@ -149,7 +149,7 @@ class _ChartBarDataItemTouch {
   /// Defaults to Size.zero
   Size get lastSize => _size.last;
 
-  /// Dispose all animations.
+  /// Disposing all animations.
   void dispose() {
     _pos.dispose();
     _size.dispose();
@@ -221,7 +221,7 @@ class _ChartBarDataItemValue {
   /// Defaults to Size.zero
   Size get lastSize => _size.last;
 
-  /// Dispose all animations.
+  /// Disposing all animations.
   void dispose() {
     _color.dispose();
     _pos.dispose();

lib/src/models/bar/chart_bar_layer.dart

@@ -6,20 +6,20 @@ import 'package:flutter/material.dart';
 part 'chart_bar_data_item.dart';
 part 'chart_bar_settings.dart';
 
-/// Provides paint for bar layer.
+/// This layer allows to render bars.
 class ChartBarLayer extends ChartLayer {
-  /// The items data of bar.
+  /// The items data of bars.
   final List<ChartBarDataItem> items;
 
-  /// The settings of bar.
+  /// The settings of bars.
   final ChartBarSettings settings;
 
   const ChartBarLayer({
     required this.items,
     required this.settings,
   });
 
-  /// Dispose all animations.
+  /// Disposing all animations.
   @override
   void dispose() {
     for (final ChartBarDataItem item in items) {

lib/src/models/bar/chart_bar_settings.dart

@@ -1,13 +1,13 @@
 part of 'chart_bar_layer.dart';
 
-/// Provides settings of bar.
+/// A collection of values for settings in bars.
 class ChartBarSettings {
-  /// The radius of bar.
+  /// The radius of bars.
   ///
   /// Defaults to 4.0
   final BorderRadius radius;
 
-  /// The thickness of bar.
+  /// The thickness of bars.
   ///
   /// Defaults to BorderRadius.zero
   final double thickness;

lib/src/models/candle/chart_candle_data_item.dart

@@ -1,6 +1,6 @@
 part of 'chart_candle_layer.dart';
 
-/// Provides data item of candle.
+/// A collection of values for a candle in a chart.
 class ChartCandleDataItem {
   /// The color of candle item.
   final Color color;
@@ -21,7 +21,7 @@ class ChartCandleDataItem {
     required this.x,
   });
 
-  /// Dispose all animations.
+  /// Disposing all animations.
   void dispose() {
     value1.dispose();
     value2.dispose();