mirror of
https://github.com/dart-lang/sdk
synced 2024-09-16 02:17:14 +00:00
Fix some dart sdk documentation issues
Mostly fixes unresolved references but fixes some other small issues as well Bug: https://github.com/dart-lang/sdk/issues/37880 Change-Id: I5747c3c90d66d23859e021fc6bd07cc7cd9700d2 Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/103741 Commit-Queue: Samuel Rawlins <srawlins@google.com> Reviewed-by: Lasse R.H. Nielsen <lrn@google.com> Reviewed-by: Zach Anderson <zra@google.com>
This commit is contained in:
parent
326c00c6d7
commit
bb879969dd
|
@ -1096,9 +1096,9 @@ abstract class Stream<T> {
|
|||
* When subscribing using [drain], cancelOnError will be true. This means
|
||||
* that the future will complete with the first error on this stream and then
|
||||
* cancel the subscription.
|
||||
* If this stream emits an error, or the call to [combine] throws,
|
||||
* the returned future is completed with that error,
|
||||
* and processing is stopped.
|
||||
*
|
||||
* If this stream emits an error, the returned future is completed with
|
||||
* that error, and processing is stopped.
|
||||
*
|
||||
* In case of a `done` event the future completes with the given
|
||||
* [futureValue].
|
||||
|
|
|
@ -35,18 +35,18 @@ const Base64Codec base64Url = Base64Codec.urlSafe();
|
|||
|
||||
/// Encodes [bytes] using [base64](https://tools.ietf.org/html/rfc4648) encoding.
|
||||
///
|
||||
/// Shorthand for [base64.encode]. Useful if a local variable shadows the global
|
||||
/// Shorthand for `base64.encode`. Useful if a local variable shadows the global
|
||||
/// [base64] constant.
|
||||
String base64Encode(List<int> bytes) => base64.encode(bytes);
|
||||
|
||||
/// Encodes [bytes] using [base64url](https://tools.ietf.org/html/rfc4648) encoding.
|
||||
///
|
||||
/// Shorthand for [base64url.encode].
|
||||
/// Shorthand for `base64url.encode`.
|
||||
String base64UrlEncode(List<int> bytes) => base64Url.encode(bytes);
|
||||
|
||||
/// Decodes [base64](https://tools.ietf.org/html/rfc4648) or [base64url](https://tools.ietf.org/html/rfc4648) encoded bytes.
|
||||
///
|
||||
/// Shorthand for [base64.decode]. Useful if a local variable shadows the
|
||||
/// Shorthand for `base64.decode`. Useful if a local variable shadows the
|
||||
/// global [base64] constant.
|
||||
Uint8List base64Decode(String source) => base64.decode(source);
|
||||
|
||||
|
|
|
@ -74,10 +74,10 @@ const JsonCodec json = JsonCodec();
|
|||
/// If [toEncodable] is omitted, it defaults to a function that returns the
|
||||
/// result of calling `.toJson()` on the unencodable object.
|
||||
///
|
||||
/// Shorthand for [json.encode]. Useful if a local variable shadows the global
|
||||
/// Shorthand for `json.encode`. Useful if a local variable shadows the global
|
||||
/// [json] constant.
|
||||
String jsonEncode(Object object, {Object toEncodable(Object nonEncodable)}) =>
|
||||
json.encode(object, toEncodable: toEncodable);
|
||||
String jsonEncode(Object value, {Object toEncodable(Object nonEncodable)}) =>
|
||||
json.encode(value, toEncodable: toEncodable);
|
||||
|
||||
/// Parses the string and returns the resulting Json object.
|
||||
///
|
||||
|
@ -88,7 +88,7 @@ String jsonEncode(Object object, {Object toEncodable(Object nonEncodable)}) =>
|
|||
///
|
||||
/// The default [reviver] (when not provided) is the identity function.
|
||||
///
|
||||
/// Shorthand for [json.decode]. Useful if a local variable shadows the global
|
||||
/// Shorthand for `json.decode`. Useful if a local variable shadows the global
|
||||
/// [json] constant.
|
||||
dynamic jsonDecode(String source, {Object reviver(Object key, Object value)}) =>
|
||||
json.decode(source, reviver: reviver);
|
||||
|
|
|
@ -83,7 +83,7 @@ abstract class Map<K, V> {
|
|||
* Creates an identity map with the default implementation, [LinkedHashMap].
|
||||
*
|
||||
* An identity map uses [identical] for equality and [identityHashCode]
|
||||
* for hash codes of keys instead of the intrinsic [Object.operator==] and
|
||||
* for hash codes of keys instead of the intrinsic [Object.==] and
|
||||
* [Object.hashCode] of the keys.
|
||||
*
|
||||
* The returned map allows `null` as a key.
|
||||
|
|
|
@ -152,7 +152,7 @@ abstract class RegExp implements Pattern {
|
|||
* character is a line terminator. When true, then the "." character will
|
||||
* match any single character including line terminators.
|
||||
*
|
||||
* This feature is distinct from [isMultiline], as they affect the behavior
|
||||
* This feature is distinct from [isMultiLine], as they affect the behavior
|
||||
* of different pattern characters, and so they can be used together or
|
||||
* separately.
|
||||
*/
|
||||
|
|
|
@ -406,16 +406,16 @@ enum _RawSocketOptions {
|
|||
IPPROTO_UDP, // 6
|
||||
}
|
||||
|
||||
/// The [RawSocketOption] is used as a parameter to [Socket.setRawOption] and
|
||||
/// [RawSocket.setRawOption] to set customize the behaviour of the underlying
|
||||
/// socket.
|
||||
/// The [RawSocketOption] is used as a parameter to [Socket.setRawOption],
|
||||
/// [RawSocket.setRawOption], and [RawDatagramSocket.setRawOption] to customize
|
||||
/// the behaviour of the underlying socket.
|
||||
///
|
||||
/// It allows for fine grained control of the socket options, and its values will
|
||||
/// be passed to the underlying platform's implementation of setsockopt and
|
||||
/// getsockopt.
|
||||
/// It allows for fine grained control of the socket options, and its values
|
||||
/// will be passed to the underlying platform's implementation of `setsockopt`
|
||||
/// and `getsockopt`.
|
||||
@Since("2.2")
|
||||
class RawSocketOption {
|
||||
/// Creates a RawSocketOption for getRawOption andSetRawOption.
|
||||
/// Creates a [RawSocketOption] for `getRawOption` and `setRawOption`.
|
||||
///
|
||||
/// All arguments are required and must not be null.
|
||||
///
|
||||
|
@ -425,10 +425,10 @@ class RawSocketOption {
|
|||
/// The value argument and its length correspond to the optval and length
|
||||
/// arguments on the native call.
|
||||
///
|
||||
/// For a [getRawOption] call, the value parameter will be updated after a
|
||||
/// For a `getRawOption` call, the value parameter will be updated after a
|
||||
/// successful call (although its length will not be changed).
|
||||
///
|
||||
/// For a [setRawOption] call, the value parameter will be used set the
|
||||
/// For a `setRawOption` call, the value parameter will be used set the
|
||||
/// option.
|
||||
const RawSocketOption(this.level, this.option, this.value);
|
||||
|
||||
|
|
|
@ -39,7 +39,7 @@ class Stdin extends _StdStream implements Stream<List<int>> {
|
|||
* Blocks until a full line is available.
|
||||
*
|
||||
* Lines my be terminated by either `<CR><LF>` or `<LF>`. On Windows in cases
|
||||
* where the [stdioType] of stdin is [StdioType.termimal] the terminator may
|
||||
* where the [stdioType] of stdin is [StdioType.terminal] the terminator may
|
||||
* also be a single `<CR>`.
|
||||
*
|
||||
* Input bytes are converted to a string by [encoding].
|
||||
|
|
|
@ -56,7 +56,7 @@
|
|||
/// Functions and closures are proxied in such a way that they are callable. A
|
||||
/// Dart closure assigned to a JavaScript property is proxied by a function in
|
||||
/// JavaScript. A JavaScript function accessed from Dart is proxied by a
|
||||
/// [JsFunction], which has a [apply] method to invoke it.
|
||||
/// [JsFunction], which has a [JsFunction.apply] method to invoke it.
|
||||
///
|
||||
/// The following types are transferred directly and not proxied:
|
||||
///
|
||||
|
|
|
@ -9,7 +9,7 @@ part of dart.math;
|
|||
/// The default implementation supplies a stream of pseudo-random bits that are
|
||||
/// not suitable for cryptographic purposes.
|
||||
///
|
||||
/// Use the [Random.secure]() constructor for cryptographic purposes.
|
||||
/// Use the [Random.secure] constructor for cryptographic purposes.
|
||||
abstract class Random {
|
||||
/// Creates a random number generator.
|
||||
///
|
||||
|
|
Loading…
Reference in a new issue