Add more dartdoc comments to public API

Author: davigmacode

lib/src/choices.dart

@@ -6,14 +6,25 @@ import './choices_grouped.dart';
 import './choices_list.dart';
 import './choices_empty.dart';
 
+/// modal choice widget
 class S2Choices<T> extends StatelessWidget {
 
+  /// builder of single choice widget
   final Widget Function(S2Choice<T>) itemBuilder;
+
+  /// list of choice data
   final List<S2Choice<T>> items;
+
+  /// configuration of choice widget
   final S2ChoiceConfig config;
+
+  /// collection of available builder widget
   final S2Builder<T> builder;
+
+  /// current filter query
   final String query;
 
+  /// default constructor
   S2Choices({
     Key key,
     @required this.itemBuilder,
@@ -54,14 +65,14 @@ class S2Choices<T> extends StatelessWidget {
       : _nonHiddenItems;
   }
 
-  // return a non hidden option item
+  /// return a non hidden option item
   List<S2Choice<T>> get _nonHiddenItems {
     return items
       .where((S2Choice<T> item) => item.hidden != true)
       .toList().cast<S2Choice<T>>();
   }
 
-  // return a sorted list of group keys
+  /// return a sorted list of group keys
   List<String> get _groupKeys {
     Set groups = Set();
     _filteredItems.forEach((S2Choice<T> item) => groups.add(item.group));
@@ -72,6 +83,7 @@ class S2Choices<T> extends StatelessWidget {
       ..sort((a, b) => a.toLowerCase().compareTo(b.toLowerCase()));
   }
 
+  /// whether the list need to be grouped or not
   bool get _isGrouped {
     return config.isGrouped && _groupKeys != null && _groupKeys.isNotEmpty;
   }

lib/src/choices_empty.dart

@@ -1,7 +1,9 @@
 import 'package:flutter/widgets.dart';
 
+/// Default widget for empty choices list
 class S2ChoicesEmpty extends StatelessWidget {
 
+  /// default constructor
   const S2ChoicesEmpty();
 
   @override

lib/src/choices_grouped.dart

@@ -7,15 +7,28 @@ import 'choices_list.dart';
 import 'scrollbar.dart';
 import 'text.dart';
 
+/// grouped choices list widget
 class S2ChoicesGrouped<T> extends StatelessWidget {
 
+  /// list of string of group name
   final List<String> groupKeys;
+
+  /// item builder of choice widget
   final Widget Function(S2Choice<T>) itemBuilder;
+
+  /// list of item of choice data
   final List<S2Choice<T>> items;
+
+  /// choices configuration
   final S2ChoiceConfig config;
+
+  /// collection of builder widget
   final S2Builder<T> builder;
+
+  /// current filter query
   final String query;
 
+  /// default constructor
   S2ChoicesGrouped({
     Key key,
     @required this.groupKeys,
@@ -45,7 +58,7 @@ class S2ChoicesGrouped<T> extends StatelessWidget {
                 style: config.headerStyle,
               );
               final Widget groupHeader = builder.choiceHeader?.call(context, group, query)
-                ?? SmartSelectChoicesGroupedHeader(
+                ?? S2ChoicesGroupedHeader(
                     group: group,
                     query: query,
                   );
@@ -76,12 +89,17 @@ class S2ChoicesGrouped<T> extends StatelessWidget {
   }
 }
 
-class SmartSelectChoicesGroupedHeader extends StatelessWidget {
+/// choice group header widget
+class S2ChoicesGroupedHeader extends StatelessWidget {
 
+  /// choices group data
   final S2ChoiceGroup group;
+
+  /// current filter query
   final String query;
 
-  SmartSelectChoicesGroupedHeader({
+  /// default constructor
+  S2ChoicesGroupedHeader({
     Key key,
     this.group,
     this.query,

lib/src/choices_list.dart

@@ -5,13 +5,22 @@ import 'model/choice_theme.dart';
 import 'model/choice_item.dart';
 import 'scrollbar.dart';
 
+/// choices list widget
 class S2ChoicesList<T> extends StatelessWidget {
 
+  /// single choice widget builder
   final Widget Function(S2Choice<T>) itemBuilder;
+
+  /// list of choice data
   final List<S2Choice<T>> items;
+
+  /// configuration of single choice widget
   final S2ChoiceConfig config;
+
+  /// collection of available builder widget
   final S2Builder<T> builder;
 
+  /// default constructor
   S2ChoicesList({
     Key key,
     @required this.itemBuilder,
@@ -20,6 +29,7 @@ class S2ChoicesList<T> extends StatelessWidget {
     @required this.builder,
   }) : super(key: key);
 
+  /// get choice style
   S2ChoiceStyle get style => config.style;
 
   @override
@@ -115,12 +125,19 @@ class S2ChoicesList<T> extends StatelessWidget {
   }
 }
 
+/// default divider widget
 class S2Divider extends StatelessWidget {
 
+  /// divider color
   final Color color;
+
+  /// divider height
   final double height;
+
+  /// divider spacing
   final double spacing;
 
+  /// default constructor
   const S2Divider({
     Key key,
     this.color,

lib/src/choices_resolver.dart

@@ -5,24 +5,35 @@ import 'model/choice_theme.dart';
 import 'model/choice_item.dart';
 import 'text.dart';
 
+/// resolve the choice builder based on choice type
 class S2ChoiceResolver<T> {
 
+  /// whether single or multiple choice
   final bool isMultiChoice;
+
+  /// the choice type
   final S2ChoiceType type;
+
+  /// the choice style
   final S2ChoiceStyle style;
+
+  /// the collection of available builder widget
   final S2Builder<T> builder;
 
+  /// default constructor
   S2ChoiceResolver({
     @required this.isMultiChoice,
     @required this.type,
     @required this.style,
     @required this.builder,
   });
 
+  /// get the choice builder
   S2ChoiceBuilder<T> get choiceBuilder {
     return builder.choice ?? defaultChoiceBuilder;
   }
 
+  /// get correct builder based on choice type
   S2ChoiceBuilder<T> get defaultChoiceBuilder {
     return type == S2ChoiceType.checkboxes
       ? checkboxBuilder
@@ -35,6 +46,7 @@ class S2ChoiceResolver<T> {
             : null;
   }
 
+  /// get radio builder
   S2ChoiceBuilder<T> get radioBuilder => (
     BuildContext context,
     S2Choice<T> choice,
@@ -50,6 +62,7 @@ class S2ChoiceResolver<T> {
         value: choice.value,
       );
 
+  /// get switch builder
   S2ChoiceBuilder<T> get switchBuilder => (
     BuildContext context,
     S2Choice<T> choice,
@@ -68,6 +81,7 @@ class S2ChoiceResolver<T> {
         value: choice.selected,
       );
 
+  /// get checkbox builder
   S2ChoiceBuilder<T> get checkboxBuilder => (
     BuildContext context,
     S2Choice<T> choice,
@@ -84,6 +98,7 @@ class S2ChoiceResolver<T> {
         value: choice.selected,
       );
 
+  /// get chip builder
   S2ChoiceBuilder<T> get chipBuilder => (
     BuildContext context,
     S2Choice<T> choice,
@@ -138,7 +153,7 @@ class S2ChoiceResolver<T> {
     );
   };
 
-  // build title widget
+  /// build title widget
   Widget getTitle(BuildContext context, S2Choice<T> choice, String searchText) {
     return choice.title != null
     ? builder.choiceTitle != null
@@ -152,7 +167,7 @@ class S2ChoiceResolver<T> {
     : null;
   }
 
-  // build subtitle widget
+  /// build subtitle widget
   Widget getSubtitle(BuildContext context, S2Choice<T> choice, String searchText) {
     return choice.subtitle != null
       ? builder.choiceSubtitle != null
@@ -166,7 +181,7 @@ class S2ChoiceResolver<T> {
       : null;
   }
 
-  // build secondary/avatar widget
+  /// build secondary/avatar widget
   Widget getSecondary(BuildContext context, S2Choice<T> choice, String searchText) {
     return builder.choiceSecondary?.call(context, choice, searchText);
   }

lib/src/model/choice_group.dart

@@ -1,5 +1,6 @@
 import './choice_theme.dart';
 
+/// choice group data
 class S2ChoiceGroup {
 
   /// Group name
@@ -11,6 +12,7 @@ class S2ChoiceGroup {
   /// Group style
   final S2ChoiceHeaderStyle style;
 
+  /// default constructor
   S2ChoiceGroup({
     this.name,
     this.count,

lib/src/state/filter.dart

@@ -1,6 +1,7 @@
 import 'package:flutter/foundation.dart';
 import 'package:flutter/widgets.dart';
 
+/// state of filter data
 class S2Filter extends ChangeNotifier {
 
   bool _activated = false;

lib/src/text.dart

@@ -1,12 +1,24 @@
 import 'package:flutter/widgets.dart';
 
+/// text widget that supports highlight
 class S2Text extends StatelessWidget {
+
+  /// the text data string
   final String text;
+
+  /// the text style
   final TextStyle style;
+
+  /// the highlight data string
   final String highlight;
+
+  /// the highlight color
   final Color highlightColor;
+
+  /// whether the match is case sensitive or not
   final bool caseSensitive;
 
+  /// default constructor
   const S2Text({
     Key key,
     this.text,

lib/src/utils/debouncer.dart

@@ -1,13 +1,21 @@
 import 'dart:async';
 
+/// A debounce function completely halts function calls
+/// until the call rate of the function falls low enough
 class Debouncer {
+
+  /// debouncer delay
   final Duration delay;
+
+  /// debouncer timer
   Timer _timer;
 
+  /// default constructor
   Debouncer({
     this.delay = const Duration(milliseconds: 300)
   });
 
+  /// run the function
   run(Function action, { Duration delay }) {
     _timer?.cancel();
     _timer = Timer(delay ?? this.delay, action);