Commit 4e59eff0 by danielroek

Improved DartDocs

parent d29751ad
...@@ -7,7 +7,7 @@ void main() { ...@@ -7,7 +7,7 @@ void main() {
runApp(BaseflowPluginExample()); runApp(BaseflowPluginExample());
} }
/// Baseflow Plugin Example application /// A Flutter application demonstrating the functionality of this plugin
class BaseflowPluginExample extends StatelessWidget { class BaseflowPluginExample extends StatelessWidget {
/// [MaterialColor] to be used in the app [ThemeData] /// [MaterialColor] to be used in the app [ThemeData]
final MaterialColor themeMaterialColor = final MaterialColor themeMaterialColor =
...@@ -56,7 +56,7 @@ class BaseflowPluginExample extends StatelessWidget { ...@@ -56,7 +56,7 @@ class BaseflowPluginExample extends StatelessWidget {
); );
} }
/// Creates [MaterialColor] based on [Color] /// Creates a [MaterialColor] based on the supplied [Color]
static MaterialColor createMaterialColor(Color color) { static MaterialColor createMaterialColor(Color color) {
List strengths = <double>[.05]; List strengths = <double>[.05];
Map swatch = <int, Color>{}; Map swatch = <int, Color>{};
...@@ -83,7 +83,8 @@ class AppHome extends StatefulWidget { ...@@ -83,7 +83,8 @@ class AppHome extends StatefulWidget {
/// Constructs the [AppHome] class /// Constructs the [AppHome] class
AppHome({Key key, this.title}) : super(key: key); AppHome({Key key, this.title}) : super(key: key);
/// Application title /// The [title] of the application, which is shown in the application's
/// title bar.
final String title; final String title;
@override @override
......
...@@ -25,13 +25,13 @@ const EdgeInsets defaultHorizontalPadding = ...@@ -25,13 +25,13 @@ const EdgeInsets defaultHorizontalPadding =
/// [EdgeInsets] to define vertical padding throughout the application. /// [EdgeInsets] to define vertical padding throughout the application.
const EdgeInsets defaultVerticalPadding = EdgeInsets.symmetric(vertical: 24); const EdgeInsets defaultVerticalPadding = EdgeInsets.symmetric(vertical: 24);
/// Returns [List] with [IconData] to show in the [AppHome] [AppBar]. /// Returns a [List] with [IconData] to show in the [AppHome] [AppBar].
final List<IconData> icons = [ final List<IconData> icons = [
Icons.list, Icons.list,
Icons.info_outline, Icons.info_outline,
]; ];
/// Returns [List] with [Widget]'s to construct pages in the [AppBar]. /// Returns a [List] with [Widget]s to construct pages in the [AppBar].
final List<Widget> pages = [ final List<Widget> pages = [
PermissionList(), PermissionList(),
InfoPage(), InfoPage(),
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment