Commit 5ebe61a1 authored by qchong's avatar qchong

Merge pull request #2574 from qchong/update-api-docs

api docs: Add descriptions for Scaffold, Theme, and ThemeData classes.
parents 183fd205 2e4fb21a
...@@ -175,6 +175,11 @@ class _FloatingActionButtonTransitionState extends State<_FloatingActionButtonTr ...@@ -175,6 +175,11 @@ class _FloatingActionButtonTransitionState extends State<_FloatingActionButtonTr
} }
} }
/// Implements the basic material design visual layout structure.
///
/// This class provides APIs for showing drawers, snackbars, and bottom sheets.
///
/// See: <https://www.google.com/design/spec/layout/structure.html>
class Scaffold extends StatefulComponent { class Scaffold extends StatefulComponent {
Scaffold({ Scaffold({
Key key, Key key,
......
...@@ -10,6 +10,7 @@ export 'theme_data.dart' show ThemeData, ThemeBrightness; ...@@ -10,6 +10,7 @@ export 'theme_data.dart' show ThemeData, ThemeBrightness;
const kThemeAnimationDuration = const Duration(milliseconds: 200); const kThemeAnimationDuration = const Duration(milliseconds: 200);
/// Applies a theme to descendant widgets.
class Theme extends InheritedWidget { class Theme extends InheritedWidget {
Theme({ Theme({
Key key, Key key,
...@@ -20,6 +21,7 @@ class Theme extends InheritedWidget { ...@@ -20,6 +21,7 @@ class Theme extends InheritedWidget {
assert(data != null); assert(data != null);
} }
/// Specifies the color and typography values for descendant widgets.
final ThemeData data; final ThemeData data;
static final ThemeData _kFallbackTheme = new ThemeData.fallback(); static final ThemeData _kFallbackTheme = new ThemeData.fallback();
......
...@@ -27,6 +27,9 @@ const Color _kLightThemeSplashColor = const Color(0x66C8C8C8); ...@@ -27,6 +27,9 @@ const Color _kLightThemeSplashColor = const Color(0x66C8C8C8);
const Color _kDarkThemeHighlightColor = const Color(0x40CCCCCC); const Color _kDarkThemeHighlightColor = const Color(0x40CCCCCC);
const Color _kDarkThemeSplashColor = const Color(0x40CCCCCC); const Color _kDarkThemeSplashColor = const Color(0x40CCCCCC);
/// Holds the color and typography values for a material design theme.
///
/// Use this class to configure a [Theme] widget.
class ThemeData { class ThemeData {
factory ThemeData({ factory ThemeData({
ThemeBrightness brightness, ThemeBrightness brightness,
......
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