class-level docs for several dart:io classes

sdk/lib/io/platform.dart

 // Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
 // 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.
 
 part of dart.io;
 
 /**
- * The [Platform] class exposes details of the machine and operating
- * system.
+ * Information about the environment in which the current program is running.
+ *
+ * Platform provides information such as the operating system,
+ * the hostname of the computer, the value of environment variables,
+ * the path to the running program,
+ * and so on.
+ *
+ * ## Get the URI to the current program

[Søren Gjesse, 2014/02/12 13:16:35]

program -> Dart script

[mem, 2014/02/12 19:17:07]

Done.

+ *
+ * Use the [script] getter to get the URI to the currently running program.

[Søren Gjesse, 2014/02/12 13:16:35]

ditto.

[mem, 2014/02/12 19:17:07]

Done.

+ *
+ *     import 'dart:io' show Platform;
+ *
+ *     void main() {
+ *       // Get the URI of the script being run.
+ *       var uri = Platform.script;
+ *       // Convert the URI to a path.
+ *       var path = uri.toFilePath();
+ *     }
+ *
+ * ## Get the value of an environment variable
+ *
+ * The [environment] getter returns a the names and values of environment
+ * variables in a [Map] that contains key-value pairs of strings. The Map is
+ * unmodifiable. This sample shows how to get the value of the `PATH`
+ * environment variable.
+ *
+ *     import 'dart:io' show Platform;
+ *
+ *     void main() {
+ *       Map<String, String> envVars = Platform.environment;
+ *       print(envVars['PATH']);
+ *     }
+ * 
+ * ## Determine the OS
+ *
+ * You can get the name of the operating system as a string with the
+ * [operatingSystem] getter. You can also use one of the static boolean
+ * getters: [isMacOS], [isLinux], and so on.

[Søren Gjesse, 2014/02/12 13:16:35]

so on -> isWindows (there are only these three.

[mem, 2014/02/12 19:17:07]

Done.

+ *
+ *     import 'dart:io' show Platform, stdout;
+ *
+ *     void main() {
+ *       // Get the operating system as a string.
+ *       String os = Platform.operatingSystem;
+ *       // Or, use a predicate getter.
+ *       if (Platform.isMacOS) {
+ *         Print('is a Mac'); 
+ *       } else {
+ *        print('is not a Mac');
+ *       }
+ *     }
+ *
+ * ## Other resources
+ *
+ * [Dart by Example](https://www.dartlang.org/dart-by-example/#dart-io-and-command-line-apps)
+ * provides additional task-oriented code samples that show how to use 
+ * various API from the [dart:io] library.
  */
 class Platform {
   static final _numberOfProcessors = _Platform.numberOfProcessors;
   static final _pathSeparator = _Platform.pathSeparator;
   static final _operatingSystem = _Platform.operatingSystem;
   static final _localHostname = _Platform.localHostname;
   static final _version = _Platform.version;
 
   // This script singleton is written to by the embedder if applicable.
   static String _nativeScript = '';
@@ skipping 36 matching lines @@
   static bool get isWindows => _operatingSystem == "windows";
 
   /**
    * Returns true if the operating system is Android.
    */
   static bool get isAndroid => _operatingSystem == "android";
 
   /**
    * Get the environment for this process.
    *
-   * The returned environment is a unmodifiable map which content is
+   * The returned environment is an unmodifiable map which content is
    * retrieved from the operating system on its first use.
    *
    * Environment variables on Windows are case-insensitive. The map
    * returned on Windows is therefore case-insensitive and will convert
    * all keys to upper case. On other platforms the returned map is
    * a standard case-sensitive map.
    */
   static Map<String, String> get environment => _Platform.environment;
 
   /**
@@ skipping 38 matching lines @@
    *
    * If there is no --package-root flag, then the empty string is returned.
    */
   static String get packageRoot => _Platform.packageRoot;
 
   /**
    * Returns the version of the current Dart runtime.
    */
   static String get version => _version;
 }