Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(94)

Side by Side Diff: sdk/lib/core/bool.dart

Issue 54203002: Update documentation on .fromEnvironment. Make bool default be false. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Added examples. Created 7 years, 1 month ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
1 // Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file 1 // Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file
2 // for details. All rights reserved. Use of this source code is governed by a 2 // for details. All rights reserved. Use of this source code is governed by a
3 // BSD-style license that can be found in the LICENSE file. 3 // BSD-style license that can be found in the LICENSE file.
4 4
5 part of dart.core; 5 part of dart.core;
6 6
7 /** 7 /**
8 * The reserved words [:true:] and [:false:] denote objects that are the only 8 * The reserved words [:true:] and [:false:] denote objects that are the only
9 * instances of this class. 9 * instances of this class.
10 * 10 *
11 * It is a compile-time error for a class to attempt to extend or implement 11 * It is a compile-time error for a class to attempt to extend or implement
12 * bool. 12 * bool.
13 */ 13 */
14 class bool { 14 class bool {
15 /** 15 /**
16 * Returns the boolean for the given environment variable [name] or 16 * Returns the boolean value of the environment declaration [name].
17 * [defaultValue] if [name] is not present. 17 *
18 * The boolean value of the declaration is `true` if the declared value is
19 * the string `"true"`. Otherwise it is false.
20 *
21 * If `name` is not declared, the result is instead [defaultValue].
22 *
23 * This constructor is equivalent to:
24 *
25 * const String.fromEnvironment(name,
26 * defaultValue: "$defaultValue") == "true"
27 *
28 * Example:
29 *
30 * var useFlooFlag = const bool.fromEnvironment("floo");
Søren Gjesse 2013/10/31 08:14:30 Maybe write something more useful here, e.g floo -
Lasse Reichstein Nielsen 2013/10/31 11:52:19 Done.
31 *
32 * If you want to use a different truth-string, you can use the
33 * [String.fromEnvironment] constructor directly:
34 *
35 * var isFlooOn = const String.fromEnvironment("flooFlag") == "on";
18 */ 36 */
19 external const factory bool.fromEnvironment(String name, {bool defaultValue}); 37 external const factory bool.fromEnvironment(String name,
38 {bool defaultValue: false});
20 39
21 /** 40 /**
22 * Returns [:"true":] if the receiver is [:true:], or [:"false":] if the 41 * Returns [:"true":] if the receiver is [:true:], or [:"false":] if the
23 * receiver is [:false:]. 42 * receiver is [:false:].
24 */ 43 */
25 String toString() { 44 String toString() {
26 return this ? "true" : "false"; 45 return this ? "true" : "false";
27 } 46 }
28 } 47 }
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698