Better EnumSet and EnumMap class descriptions

marc-mabe · marc-mabe · commit e168145aa3ff · 2017-09-07T22:38:33.000+02:00
diff --git a/src/EnumMap.php b/src/EnumMap.php
@@ -6,7 +6,8 @@
 use InvalidArgumentException;
 
 /**
- * EnumMap implementation in base of SplObjectStorage
+ * A map of enumerator keys of the given enumeration (EnumMap<T>)
+ * based on SplObjectStorage
  *
  * @link http://github.com/marc-mabe/php-enum for the canonical source repository
  * @copyright Copyright (c) 2017 Marc Bennewitz
diff --git a/src/EnumSet.php b/src/EnumSet.php
@@ -7,7 +7,8 @@
 use InvalidArgumentException;
 
 /**
- * This EnumSet is based on a bitset of a binary string.
+ * A set of enumerators of the given enumeration (EnumSet<T>)
+ * based on an integer or binary bitset depending of given enumeration size.
  *
  * @link http://github.com/marc-mabe/php-enum for the canonical source repository
  * @copyright Copyright (c) 2017 Marc Bennewitz

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,8 @@`
`6`	`6`	`use InvalidArgumentException;`
`7`	`7`
`8`	`8`	`/**`
`9`		`- * EnumMap implementation in base of SplObjectStorage`
	`9`	`+ * A map of enumerator keys of the given enumeration (EnumMap<T>)`
	`10`	`+ * based on SplObjectStorage`
`10`	`11`	`*`
`11`	`12`	`* @link http://github.com/marc-mabe/php-enum for the canonical source repository`
`12`	`13`	`* @copyright Copyright (c) 2017 Marc Bennewitz`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,8 @@`
`7`	`7`	`use InvalidArgumentException;`
`8`	`8`
`9`	`9`	`/**`
`10`		`- * This EnumSet is based on a bitset of a binary string.`
	`10`	`+ * A set of enumerators of the given enumeration (EnumSet<T>)`
	`11`	`+ * based on an integer or binary bitset depending of given enumeration size.`
`11`	`12`	`*`
`12`	`13`	`* @link http://github.com/marc-mabe/php-enum for the canonical source repository`
`13`	`14`	`* @copyright Copyright (c) 2017 Marc Bennewitz`