From 5fe32098b55b13e5200071b7eff4b039b377ba4b Mon Sep 17 00:00:00 2001
From: xster <xiao@xster.net>
Date: Mon, 20 Nov 2017 10:34:48 -0800
Subject: [PATCH] reverse doc from image providers back to image shorthands
 (#13074)

---
 .../flutter/lib/src/services/image_provider.dart | 16 ++++++++++++++++
 .../lib/src/services/image_resolution.dart       |  4 ++++
 2 files changed, 20 insertions(+)

diff --git a/packages/flutter/lib/src/services/image_provider.dart b/packages/flutter/lib/src/services/image_provider.dart
index fa707809f8..7cef5cf453 100644
--- a/packages/flutter/lib/src/services/image_provider.dart
+++ b/packages/flutter/lib/src/services/image_provider.dart
@@ -390,6 +390,10 @@ abstract class AssetBundleImageProvider extends ImageProvider<AssetBundleImageKe
 /// Fetches the given URL from the network, associating it with the given scale.
 ///
 /// The image will be cached regardless of cache headers from the server.
+///
+/// See also:
+///
+///  * [Image.network] for a shorthand of an [Image] widget backed by [NetworkImage].
 // TODO(ianh): Find some way to honour cache headers to the extent that when the
 // last reference to an image is released, we proactively evict the image from
 // our cache if the headers describe the image as having expired at that point.
@@ -459,6 +463,10 @@ class NetworkImage extends ImageProvider<NetworkImage> {
 
 /// Decodes the given [File] object as an image, associating it with the given
 /// scale.
+///
+/// See also:
+///
+///  * [Image.file] for a shorthand of an [Image] widget backed by [FileImage].
 class FileImage extends ImageProvider<FileImage> {
   /// Creates an object that decodes a [File] as an image.
   ///
@@ -523,6 +531,10 @@ class FileImage extends ImageProvider<FileImage> {
 /// that changes over time, consider creating a new subclass of [ImageProvider]
 /// whose [load] method returns a subclass of [ImageStreamCompleter] that can
 /// handle providing multiple images.
+///
+/// See also:
+///
+///  * [Image.memory] for a shorthand of an [Image] widget backed by [MemoryImage].
 class MemoryImage extends ImageProvider<MemoryImage> {
   /// Creates an object that decodes a [Uint8List] buffer as an image.
   ///
@@ -638,6 +650,10 @@ class MemoryImage extends ImageProvider<MemoryImage> {
 /// Note that the `lib/` is implied, so it should not be included in the asset
 /// path.
 ///
+/// See also:
+///
+///  * [Image.asset] for a shorthand of an [Image] widget backed by
+///    [ExactAssetImage] when using a scale.
 class ExactAssetImage extends AssetBundleImageProvider {
   /// Creates an object that fetches the given image from an asset bundle.
   ///
diff --git a/packages/flutter/lib/src/services/image_resolution.dart b/packages/flutter/lib/src/services/image_resolution.dart
index d5c4495c7e..d31309ecbd 100644
--- a/packages/flutter/lib/src/services/image_resolution.dart
+++ b/packages/flutter/lib/src/services/image_resolution.dart
@@ -113,6 +113,10 @@ const String _kAssetManifestFileName = 'AssetManifest.json';
 /// Note that the `lib/` is implied, so it should not be included in the asset
 /// path.
 ///
+/// See also:
+///
+///  * [Image.asset] for a shorthand of an [Image] widget backed by [AssetImage]
+///    when used without a scale.
 class AssetImage extends AssetBundleImageProvider {
   /// Creates an object that fetches an image from an asset bundle.
   ///