Add documentation

mono0926 · Apr 28, 2022 · 4de0662 · 4de0662
1 parent 620147f
commit 4de0662
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/src/adaptive_dialog.dart b/lib/src/adaptive_dialog.dart
@@ -1,6 +1,7 @@
 import 'package:adaptive_dialog/adaptive_dialog.dart';
 import 'package:flutter/material.dart';
 
+/// Manage common adaptive_dialog settings, etc.
 class AdaptiveDialog {
   AdaptiveDialog._();
   static AdaptiveDialog? _instance;
@@ -13,6 +14,7 @@ class AdaptiveDialog {
   AdaptiveStyle get defaultStyle => _defaultStyle;
   AdaptiveDialogMacOSConfiguration get macOS => _macOs;
 
+  /// Update default configuration
   // ignore: use_setters_to_change_properties
   void updateConfiguration({
     AdaptiveStyle? defaultStyle,
@@ -23,10 +25,12 @@ class AdaptiveDialog {
   }
 }
 
+/// Manage common macOS settings
 class AdaptiveDialogMacOSConfiguration {
   AdaptiveDialogMacOSConfiguration({
     this.applicationIcon,
   });
 
+  /// Used for macOS style dialog
   final Widget? applicationIcon;
 }