Browse Source

Doc tweaks

David Peek 12 years ago
parent
commit
cbd322dd22
3 changed files with 14 additions and 14 deletions
  1. 3 4
      std/Date.hx
  2. 2 2
      std/EReg.hx
  3. 9 8
      std/Map.hx

+ 3 - 4
std/Date.hx

@@ -112,9 +112,9 @@ extern class Date
 		Returns a Date from a formated string `s`, with the following accepted
 		Returns a Date from a formated string `s`, with the following accepted
 		formats:
 		formats:
 		
 		
-		- [YYYY-MM-DD hh:mm:ss]
-		- [YYYY-MM-DD]
-		- [hh:mm:ss]
+		- `"YYYY-MM-DD hh:mm:ss"`
+		- `"YYYY-MM-DD"`
+		- `"hh:mm:ss"`
 		
 		
 		The first two formats are expressed in local time, the third in UTC
 		The first two formats are expressed in local time, the third in UTC
 		Epoch.
 		Epoch.
@@ -188,4 +188,3 @@ extern class Date
 	}
 	}
 #end
 #end
 }
 }
-

+ 2 - 2
std/EReg.hx

@@ -41,7 +41,7 @@ class EReg {
 	/**
 	/**
 		Creates a new regular expression with pattern `r` and modifiers `opt`.
 		Creates a new regular expression with pattern `r` and modifiers `opt`.
 		
 		
-		This is equivalent to the shorthand syntax ~/r/opt
+		This is equivalent to the shorthand syntax `~/r/opt`
 		
 		
 		If `r` or `opt` are null, the result is unspecified.
 		If `r` or `opt` are null, the result is unspecified.
 	**/
 	**/
@@ -54,7 +54,7 @@ class EReg {
 		
 		
 		This method modifies the internal state.
 		This method modifies the internal state.
 		
 		
-		If `s` is null, the result is unspecified.
+		If `s` is `null`, the result is unspecified.
 	**/
 	**/
 	public function match( s : String ) : Bool {
 	public function match( s : String ) : Bool {
 		return false;
 		return false;

+ 9 - 8
std/Map.hx

@@ -50,10 +50,10 @@ abstract Map<K,V>(IMap<K,V> ) {
 		This becomes a constructor call to one of the specialization types in
 		This becomes a constructor call to one of the specialization types in
 		the output. The rules for that are as follows:
 		the output. The rules for that are as follows:
 		
 		
-		1. if K is a String, haxe.ds.StringMap is used
-		2. if K is an Int, haxe.ds.IntMap is used
-		3. if K is an enum, haxe.ds.EnumValueMap is used
-		4. if K is any other class or structure, haxe.ds.ObjectMap is used
+		1. if K is a `String`, `haxe.ds.StringMap` is used
+		2. if K is an `Int`, `haxe.ds.IntMap` is used
+		3. if K is an `EnumValue`, `haxe.ds.EnumValueMap` is used
+		4. if K is any other class or structure, `haxe.ds.ObjectMap` is used
 		5. if K is any other type, it causes a compile-time error
 		5. if K is any other type, it causes a compile-time error
 			
 			
 		(Cpp) Map does not use weak keys on ObjectMap by default.
 		(Cpp) Map does not use weak keys on ObjectMap by default.
@@ -74,12 +74,13 @@ abstract Map<K,V>(IMap<K,V> ) {
 		
 		
 		If no such mapping exists, null is returned.
 		If no such mapping exists, null is returned.
 		
 		
-		Note that a check like map.get(key) == null can hold for two reasons:
+		Note that a check like `map.get(key) == null` can hold for two reasons:
 		
 		
 		1. the map has no mapping for `key`
 		1. the map has no mapping for `key`
-		2. the map has a mapping with a value of null
+		2. the map has a mapping with a value of `null`
 		
 		
-		If it is important to distinguish these cases, exists() should be used.
+		If it is important to distinguish these cases, `exists()` should be 
+		used.
 		
 		
 		If `key` is null, the result is unspecified.
 		If `key` is null, the result is unspecified.
 	**/
 	**/
@@ -173,4 +174,4 @@ interface IMap<K,V> {
 
 
 private typedef Hashable = {
 private typedef Hashable = {
 	function hashCode():Int;
 	function hashCode():Int;
-}
+}