fix doc comments (#497)

Author: kevmoo

analysis_options.yaml

@@ -30,7 +30,7 @@ linter:
   - await_only_futures
   - camel_case_types
   - cascade_invocations
-  # comment_references
+  - comment_references
   - constant_identifier_names
   - control_flow_in_finally
   - curly_braces_in_flow_control_structures

lib/http.dart

@@ -7,7 +7,10 @@ import 'dart:convert';
 import 'dart:typed_data';
 
 import 'src/client.dart';
+import 'src/exception.dart';
+import 'src/request.dart';
 import 'src/response.dart';
+import 'src/streamed_request.dart';
 
 export 'src/base_client.dart';
 export 'src/base_request.dart';

lib/src/base_client.dart

@@ -6,6 +6,7 @@ import 'dart:convert';
 import 'dart:typed_data';
 
 import 'base_request.dart';
+import 'byte_stream.dart';
 import 'client.dart';
 import 'exception.dart';
 import 'request.dart';

lib/src/base_request.dart

@@ -6,6 +6,9 @@ import 'dart:collection';
 
 import 'package:meta/meta.dart';
 
+import '../http.dart' show get;
+import 'base_client.dart';
+import 'base_response.dart';
 import 'byte_stream.dart';
 import 'client.dart';
 import 'streamed_response.dart';
@@ -67,7 +70,7 @@ abstract class BaseRequest {
   /// The maximum number of redirects to follow when [followRedirects] is true.
   ///
   /// If this number is exceeded the [BaseResponse] future will signal a
-  /// [RedirectException]. Defaults to 5.
+  /// `RedirectException`. Defaults to 5.
   int get maxRedirects => _maxRedirects;
   int _maxRedirects = 5;
 

lib/src/base_response.dart

@@ -2,6 +2,7 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
+import 'base_client.dart';
 import 'base_request.dart';
 
 /// The base class for HTTP responses.

lib/src/client.dart

@@ -10,6 +10,7 @@ import 'base_request.dart';
 import 'client_stub.dart'
     if (dart.library.html) 'browser_client.dart'
     if (dart.library.io) 'io_client.dart';
+import 'exception.dart';
 import 'response.dart';
 import 'streamed_response.dart';
 

lib/src/mock_client.dart

@@ -7,6 +7,7 @@ import 'base_request.dart';
 import 'byte_stream.dart';
 import 'request.dart';
 import 'response.dart';
+import 'streamed_request.dart';
 import 'streamed_response.dart';
 
 // TODO(nweiz): once Dart has some sort of Rack- or WSGI-like standard for

lib/src/multipart_file.dart

@@ -8,6 +8,7 @@ import 'package:http_parser/http_parser.dart';
 
 import 'byte_stream.dart';
 import 'multipart_file_stub.dart' if (dart.library.io) 'multipart_file_io.dart';
+import 'multipart_request.dart';
 import 'utils.dart';
 
 /// A file to be uploaded as part of a [MultipartRequest].

lib/src/streamed_request.dart

@@ -4,14 +4,15 @@
 
 import 'dart:async';
 
+import 'base_client.dart';
 import 'base_request.dart';
 import 'byte_stream.dart';
 
 /// An HTTP request where the request body is sent asynchronously after the
 /// connection has been established and the headers have been sent.
 ///
 /// When the request is sent via [BaseClient.send], only the headers and
-/// whatever data has already been written to [StreamedRequest.stream] will be
+/// whatever data has already been written to [StreamedRequest.sink] will be
 /// sent immediately. More data will be sent as soon as it's written to
 /// [StreamedRequest.sink], and when the sink is closed the request will end.
 class StreamedRequest extends BaseRequest {
@@ -32,9 +33,8 @@ class StreamedRequest extends BaseRequest {
       : _controller = StreamController<List<int>>(sync: true),
         super(method, url);
 
-  /// Freezes all mutable fields other than [stream] and returns a
-  /// single-subscription [ByteStream] that emits the data being written to
-  /// [sink].
+  /// Freezes all mutable fields and returns a single-subscription [ByteStream]
+  /// that emits the data being written to [sink].
   @override
   ByteStream finalize() {
     super.finalize();

lib/testing.dart

@@ -22,4 +22,8 @@
 ///           200,
 ///           headers: {'content-type': 'application/json'});
 ///     });
+library http.testing;
+
+import 'src/mock_client.dart';
+
 export 'src/mock_client.dart';