Request sample code for popular API docs

[InMatrix]

According to analytics, the following API docs are quite popular but they don't currently have any sample code. These are easy tasks to start contributing to the Flutter repo. Please refer to Flutter's style guide if you're interested in contributing a snippet.

• https://docs.flutter.io/flutter/material/Scaffold-class.html
• https://docs.flutter.io/flutter/material/Icons-class.html
• https://docs.flutter.io/flutter/material/RaisedButton-class.html
• https://docs.flutter.io/flutter/material/TextField-class.html
• https://docs.flutter.io/flutter/widgets/Image-class.html
• https://docs.flutter.io/flutter/widgets/Icon-class.html
• https://docs.flutter.io/flutter/material/BottomNavigationBar-class.html
• https://docs.flutter.io/flutter/widgets/Expanded-class.html
• https://docs.flutter.io/flutter/widgets/Stack-class.html
• https://docs.flutter.io/flutter/widgets/Form-class.html
• https://docs.flutter.io/flutter/material/FlatButton-class.html
• https://docs.flutter.io/flutter/material/ThemeData-class.html
• https://docs.flutter.io/flutter/material/DropdownButton-class.html
• https://docs.flutter.io/flutter/material/TextFormField-class.html

[MisterJimson]

Where in the repo are these docs? I took a quick look around and couldn't find them.

[zoechi]

@MisterJimson They are mixed with the code (comments that start with ///)

flutter/packages/flutter/lib/src/material/scaffold.dart

Lines 657 to 691 in 5177a37

	/// Implements the basic material design visual layout structure.
	///
	/// This class provides APIs for showing drawers, snack bars, and bottom sheets.
	///
	/// To display a snackbar or a persistent bottom sheet, obtain the
	/// [ScaffoldState] for the current [BuildContext] via [Scaffold.of] and use the
	/// [ScaffoldState.showSnackBar] and [ScaffoldState.showBottomSheet] functions.
	///
	/// See also:
	///
	/// * [AppBar], which is a horizontal bar typically shown at the top of an app
	/// using the [appBar] property.
	/// * [BottomAppBar], which is a horizontal bar typically shown at the bottom
	/// of an app using the [bottomNavigationBar] property.
	/// * [FloatingActionButton], which is a circular button typically shown in the
	/// bottom right corner of the app using the [floatingActionButton] property.
	/// * [FloatingActionButtonLocation], which is used to place the
	/// [floatingActionButton] within the [Scaffold]'s layout.
	/// * [FloatingActionButtonAnimator], which is used to animate the
	/// [floatingActionButton] from one [floatingActionButtonLocation] to
	/// another.
	/// * [Drawer], which is a vertical panel that is typically displayed to the
	/// left of the body (and often hidden on phones) using the [drawer]
	/// property.
	/// * [BottomNavigationBar], which is a horizontal array of buttons typically
	/// shown along the bottom of the app using the [bottomNavigationBar]
	/// property.
	/// * [SnackBar], which is a temporary notification typically shown near the
	/// bottom of the app using the [ScaffoldState.showSnackBar] method.
	/// * [BottomSheet], which is an overlay typically shown near the bottom of the
	/// app. A bottom sheet can either be persistent, in which case it is shown
	/// using the [ScaffoldState.showBottomSheet] method, or modal, in which case
	/// it is shown using the [showModalBottomSheet] function.
	/// * [ScaffoldState], which is the state associated with this widget.
	/// * <https://material.google.com/layout/structure.html>

flutter/packages/flutter/lib/src/material/scaffold.dart

Lines 714 to 729 in 5177a37

	/// The primary content of the scaffold.
	///
	/// Displayed below the app bar and behind the [floatingActionButton] and
	/// [drawer]. To avoid the body being resized to avoid the window padding
	/// (e.g., from the onscreen keyboard), see [resizeToAvoidBottomPadding].
	///
	/// The widget in the body of the scaffold is positioned at the top-left of
	/// the available space between the app bar and the bottom of the scaffold. To
	/// center this widget instead, consider putting it in a [Center] widget and
	/// having that be the body. To expand this widget instead, consider
	/// putting it in a [SizedBox.expand].
	///
	/// If you have a column of widgets that should normally fit on the screen,
	/// but may overflow and would in such cases need to scroll, consider using a
	/// [ListView] as the body of the scaffold. This is also a good choice for
	/// the case where your body is a scrollable list.

[MisterJimson]

They don't seem to match with the web pages in this issue.

For example, the Scaffold API doc webpage has these sentences not present in the code.

The color of the Material widget that underlies the entire Scaffold
This class provides APIs for showing drawers, snack bars, and bottom sheets
Creates the mutable state for this widget at a given location in the tree

And these sentences from the repo's code Scaffold file are not present on the web page.

The geometry of the [Scaffold] after all its contents have been laid out
Creates a copy of this [ScaffoldGeometry] but with the given fields replaced with

This issue is about updating the API docs webpages, from what I can see there does not seem to be a direct relationship between the docs in the code and on the website, unless I am missing something.

[zoechi]

flutter/packages/flutter/lib/src/material/scaffold.dart

Line 782 in 5177a37

/// The color of the [Material] widget that underlies the entire Scaffold.

[InMatrix]

@MisterJimson Sorry about the confusion. The reason you saw the discrepancy between the docs and the code is that docs.flutter.io is generated from the beta branch of Flutter, but the code you were looking at is on the master branch. The API docs for the master branch lives at https://master-docs-flutter-io.firebaseapp.com/

[NPKompleet]

@InMatrix I just added some sample code for BottomNavigationBar and Scaffold. Would more later.