perf: add dart doc

LianjiaTech · Aug 14, 2023 · 69c6367 · 69c6367
1 parent 25c0c27
commit 69c6367
Show file tree

Hide file tree

Showing 11 changed files with 6 additions and 13 deletions.
diff --git a/lib/src/components/charts/brn_progress_bar_chart/brn_progress_bar_chart.dart b/lib/src/components/charts/brn_progress_bar_chart/brn_progress_bar_chart.dart
@@ -4,7 +4,7 @@ import 'package:flutter/material.dart';
 /// BrnProgressBarChart
 /// 柱形数据图表
 /// 展示一组或者多组数据，方便数据的查看以及对比
-/// ignore: must_be_immutable
+// ignore: must_be_immutable
 class BrnProgressBarChart extends StatefulWidget {
   /// 图表最小宽度，默认0
   final double minWidth;

diff --git a/lib/src/components/dialog/brn_share_dialog.dart b/lib/src/components/dialog/brn_share_dialog.dart
@@ -27,7 +27,6 @@ typedef BrnShareDialogGetCustomShareItemIcon = Widget? Function(int index);
 /// 可自定义分享弹框标题文案
 /// 可自定义分享弹框辅助信息
 /// 可自定义文案和分享渠道中间的分割线内文案
-///
 // ignore: must_be_immutable
 class BrnShareDialog extends StatelessWidget {
   final BuildContext context;

diff --git a/lib/src/components/dialog/brn_single_select.dart b/lib/src/components/dialog/brn_single_select.dart
@@ -94,9 +94,7 @@ class BrnSingleSelectDialog extends Dialog {
   }
 }
 
-///
 /// 单选列表弹框 widget
-///
 // ignore: must_be_immutable
 class BrnSingleSelectDialogWidget extends StatefulWidget {
   final bool isClose;

diff --git a/lib/src/components/form/items/general/brn_radio_input_item.dart b/lib/src/components/form/items/general/brn_radio_input_item.dart
@@ -14,7 +14,6 @@ import 'package:flutter/material.dart';
 /// 包括"标题"、"副标题"、"错误信息提示"、"必填项提示"、"添加/删除按钮"、"消息提示"、
 /// "单选项"等元素
 ///
-
 // ignore: must_be_immutable
 class BrnRadioInputFormItem extends StatefulWidget {
   /// 录入项的唯一标识，主要用于录入类型页面框架中

diff --git a/lib/src/components/gallery/page/brn_gallery_detail_page.dart b/lib/src/components/gallery/page/brn_gallery_detail_page.dart
@@ -17,7 +17,7 @@ import 'package:flutter/material.dart';
 /// 组件提供了（列表页<-->详情页）这种交互模式的骨架，
 /// 适用于查看图片，视频 PDF 等场景。
 /// 默认只实现了图片的查看，如果想要扩展视频或者pdf自行扩展配置接口可实现。
-/// ignore: must_be_immutable
+// ignore: must_be_immutable
 class BrnGalleryDetailPage extends StatefulWidget {
   /// 该交互下所有 item 的配置集合
   final List<BrnBasicGroupConfig> allConfig;

diff --git a/lib/src/components/picker/base/brn_picker_title.dart b/lib/src/components/picker/base/brn_picker_title.dart
@@ -7,7 +7,6 @@ import 'package:bruno/src/theme/brn_theme.dart';
 import 'package:flutter/material.dart';
 
 /// DatePicker's title widget.
-
 // ignore: must_be_immutable
 class BrnPickerTitle extends StatelessWidget {
   final BrnPickerTitleConfig pickerTitleConfig;

diff --git a/lib/src/components/picker/multi_range_picker/brn_multi_column_picker.dart b/lib/src/components/picker/multi_range_picker/brn_multi_column_picker.dart
@@ -29,7 +29,7 @@ typedef BrnOnPickerConfirm = void Function(Map<String, List<BrnPickerEntity>> re
 
 /// 从屏幕下方弹起的多级筛选选择器
 /// 可设置筛项的层级、多选、单选等筛选相关功能
-/// ignore: must_be_immutable
+// ignore: must_be_immutable
 class BrnMultiColumnPicker extends StatefulWidget {
   /// 筛选数据源
   final BrnPickerEntity entity;

diff --git a/lib/src/components/picker/time_picker/date_range_picker/brn_time_range_side_widget.dart b/lib/src/components/picker/time_picker/date_range_picker/brn_time_range_side_widget.dart
@@ -7,7 +7,6 @@ import 'package:bruno/src/theme/brn_theme.dart';
 import 'package:flutter/material.dart';
 
 /// TimeRangeSidePicker widget.
-
 // ignore: must_be_immutable
 class BrnTimeRangeSideWidget extends StatefulWidget {
   /// 可选最小时间

diff --git a/lib/src/components/selection/brn_flat_selection.dart b/lib/src/components/selection/brn_flat_selection.dart
@@ -15,7 +15,6 @@ import 'package:flutter/material.dart';
 
 /// 支持tag 、输入 、range、选择等类型混合一级筛选
 /// 也可支持点击选项跳转二级页面
-
 // ignore: must_be_immutable
 class BrnFlatSelection extends StatefulWidget {
   /// 筛选原始数据

diff --git a/lib/src/components/tag/tagview/brn_delete_tag.dart b/lib/src/components/tag/tagview/brn_delete_tag.dart
@@ -8,7 +8,7 @@ import 'package:flutter/material.dart';
 /// 可以外部主动添加和删除标签
 /// 宽高间距可设置
 /// 支持标签数量的增删
-/// ignore: must_be_immutable
+// ignore: must_be_immutable
 class BrnDeleteTag extends StatefulWidget {
   /// 初始传入的标签，当传入controller的时候，应把初始标签放入controller的构造中
   final List<String>? tags;
@@ -173,7 +173,7 @@ class _BrnDeleteTagState extends State<BrnDeleteTag> {
 }
 
 /// 标签具体子项，配置属性可参考 [BrnDeleteTag]
-/// ignore: must_be_immutable
+// ignore: must_be_immutable
 class DeleteTagItemWidget extends StatelessWidget {
   final int index;
   final String title;

diff --git a/lib/src/components/tag/tagview/brn_select_tag.dart b/lib/src/components/tag/tagview/brn_select_tag.dart
@@ -10,7 +10,7 @@ import 'package:flutter/material.dart';
 /// 支持定宽和非定宽
 /// 宽高间距可设置
 /// 支持单选和多选
-/// ignore: must_be_immutable
+// ignore: must_be_immutable
 class BrnSelectTag extends StatefulWidget {
   /// 展示的标签列表
   final List<String> tags;