Merge pull request #4989 from Gama11/patch-20

EnumTools: minor doc improvements

std/haxe/EnumTools.hx

@@ -34,7 +34,7 @@ extern class EnumTools {
 
 		If `e` has no package, the enum name is returned.
 
-		If `e` is null, the result is unspecified.
+		If `e` is `null`, the result is unspecified.
 
 		The enum name does not include any type parameters.
 	**/
@@ -46,7 +46,7 @@ extern class EnumTools {
 		Creates an instance of enum `e` by calling its constructor `constr` with
 		arguments `params`.
 
-		If `e` or `constr` is null, or if enum `e` has no constructor named
+		If `e` or `constr` is `null`, or if enum `e` has no constructor named
 		`constr`, or if the number of elements in `params` does not match the
 		expected number of constructor arguments, or if any argument has an
 		invalid type, the result is unspecified.
@@ -62,7 +62,7 @@ extern class EnumTools {
 		The constructor indices are preserved from haxe syntax, so the first
 		declared is index 0, the next index 1 etc.
 
-		If `e` or `index` is null, or if enum `e` has no constructor
+		If `e` or `index` is `null`, or if enum `e` has no constructor
 		corresponding to index `index`, or if the number of elements in `params`
 		does not match the expected number of constructor arguments, or if any
 		argument has an invalid type, the result is unspecified.
@@ -82,7 +82,7 @@ extern class EnumTools {
 		argument constructors is returned, in the order of the constructor
 		declaration.
 
-		If `e` is null, the result is unspecified.
+		If `e` is `null`, the result is unspecified.
 	**/
 	static public inline function createAll<T>(e:Enum<T>):Array<T> {
 		return Type.allEnums(e);
@@ -94,7 +94,7 @@ extern class EnumTools {
 		The order of the constructor names in the returned Array is preserved
 		from the original syntax.
 
-		If `c` is null, the result is unspecified.
+		If `c` is `null`, the result is unspecified.
 	**/
 	static public inline function getConstructors<T>(e:Enum<T>):Array<String> {
 		return Type.getEnumConstructs(e);
@@ -107,9 +107,9 @@ extern class EnumValueTools {
 		Recursively compares two enum instances `a` and `b` by value.
 
 		Unlike `a == b`, this function performs a deep equality check on the
-		arguments of the constructors, if exists.
+		arguments of the constructors (if there are any).
 
-		If `a` or `b` are null, the result is unspecified.
+		If `a` or `b` are `null`, the result is unspecified.
 	**/
 	static public inline function equals<T:EnumValue>(a:T, b:T):Bool {
 		return Type.enumEq(a, b);
@@ -120,7 +120,7 @@ extern class EnumValueTools {
 
 		The result String does not contain any constructor arguments.
 
-		If `e` is null, the result is unspecified.
+		If `e` is `null`, the result is unspecified.
 	**/
 	static public inline function getName(e:EnumValue):String {
 		return Type.enumConstructor(e);
@@ -129,12 +129,12 @@ extern class EnumValueTools {
 	/**
 		Returns a list of the constructor arguments of enum instance `e`.
 
-		If `e` has no arguments, the result is [].
+		If `e` has no arguments, the result is `[]`.
 
 		Otherwise the result are the values that were used as arguments to `e`,
 		in the order of their declaration.
 
-		If `e` is null, the result is unspecified.
+		If `e` is `null`, the result is unspecified.
 	**/
 	static public inline function getParameters(e:EnumValue):Array<Dynamic> {
 		return Type.enumParameters(e);
@@ -146,19 +146,19 @@ extern class EnumValueTools {
 		This corresponds to the original syntactic position of `e`. The index of
 		the first declared constructor is 0, the next one is 1 etc.
 
-		If `e` is null, the result is unspecified.
+		If `e` is `null`, the result is unspecified.
 	**/
 	static public inline function getIndex(e:EnumValue):Int {
 		return Type.enumIndex(e);
 	}
 
 	/**
-		Matches enum instance `e` against pattern `pattern`, returning true if
-		matching succeeded and false otherwise.
+		Matches enum instance `e` against pattern `pattern`, returning `true` if
+		matching succeeded and `false` otherwise.
 
 		Example usage:
 
-		```
+		```haxe
 		if (e.match(pattern)) {
 			// codeIfTrue
 		} else {
@@ -168,7 +168,7 @@ extern class EnumValueTools {
 
 		This is equivalent to the following code:
 
-		```
+		```haxe
 		switch (e) {
 			case pattern:
 				// codeIfTrue
@@ -183,4 +183,4 @@ extern class EnumValueTools {
 	static public function match(e:EnumValue, pattern:Dynamic):Bool {
 		return false;
 	}
-}
+}