Unverified Commit e91b8339 authored by Todd Volkert's avatar Todd Volkert Committed by GitHub

Minor doc updates (#62008)

parent 67a9ae17
...@@ -77,6 +77,12 @@ abstract class Listenable { ...@@ -77,6 +77,12 @@ abstract class Listenable {
/// ///
/// This interface is implemented by [ValueNotifier<T>] and [Animation<T>], and /// This interface is implemented by [ValueNotifier<T>] and [Animation<T>], and
/// allows other APIs to accept either of those implementations interchangeably. /// allows other APIs to accept either of those implementations interchangeably.
///
/// See also:
///
/// * [ValueListenableBuilder], a widget that uses a builder callback to
/// rebuild whenever a [ValueListenable] object triggers its notifications,
/// providing the builder with the value of the object.
abstract class ValueListenable<T> extends Listenable { abstract class ValueListenable<T> extends Listenable {
/// Abstract const constructor. This constructor enables subclasses to provide /// Abstract const constructor. This constructor enables subclasses to provide
/// const constructors so that they can be used in const expressions. /// const constructors so that they can be used in const expressions.
......
...@@ -30,11 +30,17 @@ BuildContext _getParent(BuildContext context) { ...@@ -30,11 +30,17 @@ BuildContext _getParent(BuildContext context) {
return parent; return parent;
} }
/// A class representing a particular configuration of an action. /// A class representing a particular configuration of an [Action].
/// ///
/// This class is what a key map in a [ShortcutMap] has as values, and is used /// This class is what a key map in a [ShortcutMap] has as values, and is used
/// by an [ActionDispatcher] to look up an action and invoke it, giving it this /// by an [ActionDispatcher] to look up an action and invoke it, giving it this
/// object to extract configuration information from. /// object to extract configuration information from.
///
/// See also:
///
/// * [Actions.invoke], which invokes the action associated with a specified
/// [Intent] using the [Actions] widget that most tightly encloses the given
/// [BuildContext].
@immutable @immutable
class Intent with Diagnosticable { class Intent with Diagnosticable {
/// A const constructor for an [Intent]. /// A const constructor for an [Intent].
......
...@@ -1814,10 +1814,12 @@ abstract class SingleChildRenderObjectWidget extends RenderObjectWidget { ...@@ -1814,10 +1814,12 @@ abstract class SingleChildRenderObjectWidget extends RenderObjectWidget {
/// storage for that child list, it doesn't actually provide the updating /// storage for that child list, it doesn't actually provide the updating
/// logic.) /// logic.)
/// ///
/// This will return a [RenderObject] mixing in [ContainerRenderObjectMixin], /// Subclasses must return a [RenderObject] that mixes in
/// which provides the necessary functionality to visit the children of the /// [ContainerRenderObjectMixin], which provides the necessary functionality to
/// container render object (the render object belonging to the [children] widgets). /// visit the children of the container render object (the render object
/// Typically, this is a [RenderBox] with [RenderBoxContainerDefaultsMixin]. /// belonging to the [children] widgets). Typically, subclasses will return a
/// [RenderBox] that mixes in both [ContainerRenderObjectMixin] and
/// [RenderBoxContainerDefaultsMixin].
/// ///
/// See also: /// See also:
/// ///
......
...@@ -31,6 +31,9 @@ typedef LayoutWidgetBuilder = Widget Function(BuildContext context, BoxConstrain ...@@ -31,6 +31,9 @@ typedef LayoutWidgetBuilder = Widget Function(BuildContext context, BoxConstrain
/// The [builder] function is _not_ called during layout if the parent passes /// The [builder] function is _not_ called during layout if the parent passes
/// the same constraints repeatedly. /// the same constraints repeatedly.
/// {@endtemplate} /// {@endtemplate}
///
/// Subclasses must return a [RenderObject] that mixes in
/// [RenderConstrainedLayoutBuilder].
abstract class ConstrainedLayoutBuilder<ConstraintType extends Constraints> extends RenderObjectWidget { abstract class ConstrainedLayoutBuilder<ConstraintType extends Constraints> extends RenderObjectWidget {
/// Creates a widget that defers its building until layout. /// Creates a widget that defers its building until layout.
/// ///
......
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