mirror of
https://github.com/dart-lang/sdk
synced 2024-10-14 11:58:13 +00:00
API doc updates
* Update the API doc index page * Update dart:io API description Change-Id: I3e3574fc8d188e0d2fb5033c523f314590c4214c Reviewed-on: https://dart-review.googlesource.com/43891 Reviewed-by: Kathy Walrath <kathyw@google.com> Commit-Queue: Kathy Walrath <kathyw@google.com>
This commit is contained in:
parent
1aaebedd70
commit
aee7d5773d
|
@ -1,31 +1,32 @@
|
||||||
Welcome to the Dart API reference documentation, covering the official Dart API
|
Welcome to the Dart API reference documentation, covering the core Dart API
|
||||||
libraries. Some of the most fundamental Dart libraries include:
|
libraries. Some of the most fundamental Dart libraries include:
|
||||||
|
|
||||||
* [dart:core](dart-core/dart-core-library.html): Core functionality such as strings, numbers, collections, errors, dates, and URIs.
|
* [dart:core](dart-core/dart-core-library.html): Core functionality such as
|
||||||
* [dart:html](dart-html/dart-html-library.html): DOM manipulation for web apps.
|
strings, numbers, collections, errors, dates, and URIs.
|
||||||
* [dart:io](dart-io/dart-io-library.html): I/O for command-line apps.
|
* [dart:html](dart-html/dart-html-library.html): DOM manipulation for web apps
|
||||||
|
(available only to web apps).
|
||||||
|
* [dart:io](dart-io/dart-io-library.html): I/O for non-web apps.
|
||||||
|
|
||||||
Except for `dart:core`, you must import a library before you can use it. Here's
|
Except for `dart:core`, you must import a library before you can use it. Here's
|
||||||
an example of importing `dart:html` and `dart:math`:
|
an example of importing `dart:async` and `dart:math`:
|
||||||
|
|
||||||
```dart
|
```dart
|
||||||
import 'dart:html';
|
import 'dart:async';
|
||||||
import 'dart:math';
|
import 'dart:math';
|
||||||
```
|
```
|
||||||
|
|
||||||
You can install more libraries using the pub package manager. For information
|
You can install more libraries using the
|
||||||
on finding, using, and publishing libraries with pub, see
|
[pub package manager](https://www.dartlang.org/tools/pub).
|
||||||
[pub.dartlang.org](https://pub.dartlang.org).
|
|
||||||
|
|
||||||
The main site for learning and using Dart is
|
The main site for learning and using Dart is
|
||||||
[www.dartlang.org](https://www.dartlang.org). Check out these additional pages:
|
[www.dartlang.org](https://www.dartlang.org). Check out these pages:
|
||||||
|
|
||||||
* [Tutorials](https://www.dartlang.org/docs/tutorials/)
|
* [Get started](https://www.dartlang.org/guides/get-started)
|
||||||
* [Programmer's Guide](https://www.dartlang.org/docs/)
|
* [Language tour](https://www.dartlang.org/guides/language/language-tour)
|
||||||
* [Samples](https://www.dartlang.org/samples/)
|
* [Library tour](https://www.dartlang.org/guides/libraries/library-tour)
|
||||||
* [A Tour of the Dart Libraries](https://www.dartlang.org/docs/dart-up-and-running/contents/ch03.html)
|
* [Sample code](https://www.dartlang.org/samples)
|
||||||
|
|
||||||
This API reference is automatically generated from the source code in the
|
This API reference is automatically generated from source code in the [Dart
|
||||||
[Dart project](https://github.com/dart-lang/sdk). If you'd like to contribute to
|
SDK project](https://github.com/dart-lang/sdk).
|
||||||
this documentation, see
|
If you'd like to give feedback or edit this documentation, see
|
||||||
[Contributing](https://github.com/dart-lang/sdk/wiki/Contributing).
|
[Contributing](https://github.com/dart-lang/sdk/wiki/Contributing).
|
||||||
|
|
|
@ -3,22 +3,25 @@
|
||||||
// BSD-style license that can be found in the LICENSE file.
|
// BSD-style license that can be found in the LICENSE file.
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* File, socket, HTTP, and other I/O support for server applications.
|
* File, socket, HTTP, and other I/O support for non-web applications.
|
||||||
*
|
*
|
||||||
* The I/O library is used for Dart server applications,
|
* **Important:** Browser-based applications can't use this library.
|
||||||
* which run on a stand-alone Dart VM from the command line.
|
* Only servers, command-line scripts, and Flutter mobile apps can import
|
||||||
* *This library does not work in browser-based applications.*
|
* and use dart:io.
|
||||||
*
|
*
|
||||||
* This library allows you to work with files, directories,
|
* This library allows you to work with files, directories,
|
||||||
* sockets, processes, HTTP servers and clients, and more.
|
* sockets, processes, HTTP servers and clients, and more.
|
||||||
|
* Many operations related to input and output are asynchronous
|
||||||
|
* and are handled using [Future]s or [Stream]s, both of which
|
||||||
|
* are defined in the [dart:async
|
||||||
|
* library](../dart-async/dart-async-library.html).
|
||||||
*
|
*
|
||||||
* To use this library in your code:
|
* To use the dart:io library in your code:
|
||||||
*
|
*
|
||||||
* import 'dart:io';
|
* import 'dart:io';
|
||||||
*
|
*
|
||||||
* *Note:* Many operations related to input and output are asynchronous
|
* For an introduction to I/O in Dart, see the [dart:io library
|
||||||
* and are handled using [Future]s or [Stream]s, both of which
|
* tour](https://www.dartlang.org/dart-vm/io-library-tour).
|
||||||
* are defined in the `dart:async` library.
|
|
||||||
*
|
*
|
||||||
* ## File, Directory, and Link
|
* ## File, Directory, and Link
|
||||||
*
|
*
|
||||||
|
@ -182,14 +185,6 @@
|
||||||
* (the program blocks waiting for user to type information):
|
* (the program blocks waiting for user to type information):
|
||||||
*
|
*
|
||||||
* String inputText = stdin.readLineSync();
|
* String inputText = stdin.readLineSync();
|
||||||
*
|
|
||||||
* ## Other resources
|
|
||||||
*
|
|
||||||
* For an introduction to I/O in Dart, see the [dart:io section of the library
|
|
||||||
* tour](https://www.dartlang.org/docs/dart-up-and-running/ch03.html#dartio---io-for-command-line-apps).
|
|
||||||
*
|
|
||||||
* To learn more about I/O in Dart, refer to the [tutorial about writing
|
|
||||||
* command-line apps](https://www.dartlang.org/docs/tutorials/cmdline/).
|
|
||||||
*/
|
*/
|
||||||
library dart.io;
|
library dart.io;
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue