Correcting spelling and updating incorrect documentation stubs

Michael Fero · Michael Fero · commit 144c77dd1f33 · 2016-02-11T11:38:55.000-05:00
diff --git a/ext/doc/Cassandra/Cluster/Builder.php b/ext/doc/Cassandra/Cluster/Builder.php
@@ -253,7 +253,7 @@ public function withTimestampGenerator($generator) {}
      * routing and $session->schema() will always return an empty object. This
      * can be useful for reducing the startup overhead of short-lived sessions.
      *
-     * @param bool $enabled whether the driver fetches and maintains schema metadata.
+     * @param bool $enable whether the driver fetches and maintains schema metadata.
      *
      * @return Builder self
      */
diff --git a/ext/doc/Cassandra/DefaultTable.php b/ext/doc/Cassandra/DefaultTable.php
@@ -125,25 +125,25 @@ public function compressionParameters() {}
      * {@inheritDoc}
      * @return boolean Value of `populate_io_cache_on_flush` or null
      */
-    public function populateIOCacheOnFlush();
+    public function populateIOCacheOnFlush() {}
 
     /**
      * {@inheritDoc}
      * @return boolean Value of `replicate_on_write` or null
      */
-    public function replicateOnWrite();
+    public function replicateOnWrite() {}
 
     /**
      * {@inheritDoc}
      * @return int Value of `max_index_interval` or null
      */
-    public function maxIndexInterval();
+    public function maxIndexInterval() {}
 
     /**
      * {@inheritDoc}
      * @return int Value of `min_index_interval` or null
      */
-    public function minIndexInterval();
+    public function minIndexInterval() {}
 
     /**
      * {@inheritDoc}
diff --git a/ext/doc/Cassandra/RetryPolicy/DefaultPolicy.php b/ext/doc/Cassandra/RetryPolicy/DefaultPolicy.php
@@ -24,7 +24,7 @@
  * The default retry policy. This policy retries a query, using the
  * request's original consistency level, in the following cases:
  *
- * * On a read timeout, if enough replicas replied but the data was not recieved.
+ * * On a read timeout, if enough replicas replied but the data was not received.
  * * On a write timeout, if a timeout occurs while writing a distributed batch log.
  * * On unavailable, it will move to the next host.
  *
diff --git a/ext/doc/Cassandra/RetryPolicy/Fallthrough.php b/ext/doc/Cassandra/RetryPolicy/Fallthrough.php
@@ -21,7 +21,7 @@
 use Cassandra\RetryPolicy;
 
 /**
- * A retry policy that never retries and allows all errors to fallthough.
+ * A retry policy that never retries and allows all errors to fallthrough.
  */
 final class Fallthrough implements RetryPolicy
 {
diff --git a/ext/doc/Cassandra/RetryPolicy/Logging.php b/ext/doc/Cassandra/RetryPolicy/Logging.php
@@ -28,7 +28,7 @@ final class Logging implements RetryPolicy
     /**
      * Creates a new Logging retry policy.
      *
-     * @param Cassandra\RetryPolicy $childPolicy Any retry poilcy other than
+     * @param Cassandra\RetryPolicy $childPolicy Any retry policy other than
      *                                           Cassandra\Logging
      */
     public function __construct($childPolicy) {}
diff --git a/ext/doc/Cassandra/Rows.php b/ext/doc/Cassandra/Rows.php
@@ -144,7 +144,7 @@ public function nextPageAsync() {}
      *
      * @return string
      */
-    public function pagingStateToken {}
+    public function pagingStateToken() {}
 
     /**
      * Get the first row.
diff --git a/ext/doc/Cassandra/Timestamp.php b/ext/doc/Cassandra/Timestamp.php
@@ -50,7 +50,7 @@ public function time() {}
     /**
      * Microtime from this timestamp
      *
-     * @param bool $get_as_float Whther to get this value as float
+     * @param bool $get_as_float Whether to get this value as float
      *
      * @return float|string Float or string representation
      * @see microtime
diff --git a/ext/doc/Cassandra/Tuple.php b/ext/doc/Cassandra/Tuple.php
@@ -26,7 +26,7 @@ final class Tuple implements Value, \Countable, \Iterator
     /**
      * Creates a new tuple with the given types.
      *
-     * @param array $type Array of types
+     * @param array $types Array of types
      */
     public function __construct($types) {}
 
diff --git a/ext/doc/Cassandra/Type.php b/ext/doc/Cassandra/Type.php
@@ -30,92 +30,92 @@ interface Type
     final static function varchar() {}
 
     /**
-     * Get representation of cassandra varchar type
-     * @return Cassandra\Type varchar type
+     * Get representation of cassandra text type
+     * @return Cassandra\Type text type
      */
     final static function text() {}
 
     /**
-     * Get representation of cassandra varchar type
-     * @return Cassandra\Type varchar type
+     * Get representation of cassandra blob type
+     * @return Cassandra\Type blob type
      */
     final static function blob() {}
 
       /**
-       * Get representation of cassandra varchar type
-       * @return Cassandra\Type varchar type
+       * Get representation of cassandra ascii type
+       * @return Cassandra\Type ascii type
        */
     final static function ascii() {}
 
       /**
-       * Get representation of cassandra varchar type
-       * @return Cassandra\Type varchar type
+       * Get representation of cassandra bigint type
+       * @return Cassandra\Type bigint type
        */
     final static function bigint() {}
 
       /**
-       * Get representation of cassandra varchar type
-       * @return Cassandra\Type varchar type
+       * Get representation of cassandra counter type
+       * @return Cassandra\Type counter type
        */
     final static function counter() {}
 
       /**
-       * Get representation of cassandra varchar type
-       * @return Cassandra\Type varchar type
+       * Get representation of cassandra int type
+       * @return Cassandra\Type int type
        */
     final static function int() {}
 
       /**
-       * Get representation of cassandra varchar type
-       * @return Cassandra\Type varchar type
+       * Get representation of cassandra varint type
+       * @return Cassandra\Type varint type
        */
     final static function varint() {}
 
       /**
-       * Get representation of cassandra varchar type
-       * @return Cassandra\Type varchar type
+       * Get representation of cassandra boolean type
+       * @return Cassandra\Type boolean type
        */
     final static function boolean() {}
 
       /**
-       * Get representation of cassandra varchar type
-       * @return Cassandra\Type varchar type
+       * Get representation of cassandra decimal type
+       * @return Cassandra\Type decimal type
        */
     final static function decimal() {}
 
       /**
-       * Get representation of cassandra varchar type
-       * @return Cassandra\Type varchar type
+       * Get representation of cassandra double type
+       * @return Cassandra\Type double type
        */
     final static function double() {}
 
       /**
-       * Get representation of cassandra varchar type
-       * @return Cassandra\Type varchar type
+       * Get representation of cassandra float type
+       * @return Cassandra\Type float type
        */
     final static function float() {}
 
       /**
-       * Get representation of cassandra varchar type
-       * @return Cassandra\Type varchar type
+       * Get representation of cassandra inet type
+       * @return Cassandra\Type inet type
        */
     final static function inet() {}
 
       /**
-       * Get representation of cassandra varchar type
-       * @return Cassandra\Type varchar type
+       * Get representation of cassandra timestamp type
+       * @return Cassandra\Type timestamp type
        */
     final static function timestamp() {}
 
       /**
-       * Get representation of cassandra varchar type
-       * @return Cassandra\Type varchar type
+       * Get representation of cassandra uuid type
+       * @return Cassandra\Type uuid type
        */
     final static function uuid() {}
 
       /**
-       * Get representation of cassandra varchar type
-       * @return Cassandra\Type varchar type
+       * Get representation of cassandra timeuuid type
+       * @return Cassandra\Type timeuuid type
        */
     final static function timeuuid() {}
 
@@ -171,13 +171,13 @@ final static function set(Type $type) {}
      * Returns the name of this type as string.
      * @return string Name of this type
      */
-    function name();
+    function name() {}
 
     /**
      * Returns string representation of this type.
      * @return string String representation of this type
      */
-    function __toString();
+    function __toString() {}
 
     /**
      * Instantiate a value of this type from provided value(s).
@@ -188,5 +188,5 @@ function __toString();
      * @param  mixed $value,... one or more values to coerce into this type
      * @return mixed            a value of this type
      */
-    function create($value = null);
+    function create($value = null) {}
 }
diff --git a/ext/doc/Cassandra/UserTypeValue.php b/ext/doc/Cassandra/UserTypeValue.php
@@ -26,7 +26,7 @@ final class UserTypeValue implements Value, \Countable, \Iterator
     /**
      * Creates a new user type value with the given name/type pairs.
      *
-     * @param array $type Array of types
+     * @param array $types Array of types
      */
     public function __construct($types) {}
 
diff --git a/ext/doc/Cassandra/UuidInterface.php b/ext/doc/Cassandra/UuidInterface.php
@@ -19,7 +19,7 @@
 namespace Cassandra;
 
 /**
- * A PHP representation of the CQL `timeuuid` datatype
+ * A PHP representation of the CQL `uuid` datatype
  */
 interface UuidInterface
 {
diff --git a/features/batch_statements.feature b/features/batch_statements.feature
@@ -4,7 +4,7 @@ Feature: Batch statements
   PHP Driver supports batch statements. There are three types of batch statements:
 
     * `Cassandra::BATCH_LOGGED`   - this is the default batch type. This batch
-      gurantees that either all or none of its statements will be executed.
+      guarantees that either all or none of its statements will be executed.
       This behavior is achieved by writing a batch log on the coordinator, which
       slows down the execution somewhat.
     * `Cassandra::BATCH_UNLOGGED` - this batch will not be verified when executed,
diff --git a/tests/integration/Cassandra/CollectionIntegrationTest.php b/tests/integration/Cassandra/CollectionIntegrationTest.php
@@ -111,7 +111,7 @@ public function collectionWithNestedTypes() {
     }
 
     /**
-     * Bind statment with an empty list
+     * Bind statement with an empty list
      *
      * @test
      */
diff --git a/tests/integration/Cassandra/CollectionsIntegrationTest.php b/tests/integration/Cassandra/CollectionsIntegrationTest.php
@@ -173,9 +173,10 @@ public function createUserType($userType) {
     }
 
     /**
-     * Create a table this a string key and a value use the $type parameter
+     * Create a table named for the CQL $type parameter
      *
      * @param $type Cassandra\Type
+     * @return string Table name generated from $type
      */
     public function createTable($type) {
         $query = "CREATE TABLE IF NOT EXISTS %s (key text PRIMARY KEY, value %s)";
@@ -250,6 +251,7 @@ protected function verifyValue($tableName, $type, $key, $value) {
      * using CQL
      *
      * @param $type Cassandra\Type
+     * @return string String representation of type
      */
     public static function typeString($type) {
         if ($type instanceof Type\Tuple || $type instanceof Type\Collection ||
@@ -266,6 +268,7 @@ public static function typeString($type) {
      * user type using CQL
      *
      * @param $userType Cassandra\Type
+     * @return string String representation of the UserType
      */
     public static function userTypeString($userType) {
         return sprintf("%s", implode("_", array_map(function ($name, $type) {
diff --git a/tests/integration/Cassandra/MapIntegrationTest.php b/tests/integration/Cassandra/MapIntegrationTest.php
@@ -150,7 +150,7 @@ public function mapWithNestedTypes() {
     }
 
     /**
-     * Bind statment with an empty map
+     * Bind statement with an empty map
      */
     public function testNull() {
         $mapType = Type::map(Type::int(), Type::int());
@@ -159,7 +159,7 @@ public function testNull() {
     }
 
     /**
-     * Bind statment with an null map
+     * Bind statement with an null map
      */
     public function testEmpty() {
         $mapType = Type::map(Type::int(), Type::int());
diff --git a/tests/integration/Cassandra/SchemaMetadataIntegrationTest.php b/tests/integration/Cassandra/SchemaMetadataIntegrationTest.php
@@ -235,7 +235,7 @@ public function testGetTableAndColumnByName() {
     }
 
     /**
-     * Get index options metdata from a column
+     * Get index options metadata from a column
      *
      * This test ensures that index options metadata are properly returned from
      * an indexed column.
diff --git a/tests/integration/Cassandra/SetIntegrationTest.php b/tests/integration/Cassandra/SetIntegrationTest.php
@@ -111,7 +111,7 @@ public function setWithNestedTypes() {
     }
 
     /**
-     * Bind statment with an empty set
+     * Bind statement with an empty set
      */
     public function testEmpty() {
         $setType = Type::set(Type::int());
@@ -120,7 +120,7 @@ public function testEmpty() {
     }
 
     /**
-     * Bind statment with an null set
+     * Bind statement with an null set
      */
     public function testNull() {
         $setType = Type::set(Type::int());
diff --git a/tests/integration/Cassandra/TimestampIntegrationTest.php b/tests/integration/Cassandra/TimestampIntegrationTest.php
@@ -33,7 +33,7 @@ class TimestampIntegrationTest extends BasicIntegrationTest {
     /**
      * Common insert query for timestamp tests.
      *
-     * @var sting
+     * @var string
      */
     private $insertQuery;
     /**
diff --git a/tests/integration/Cassandra/TupleIntegrationTest.php b/tests/integration/Cassandra/TupleIntegrationTest.php
@@ -169,7 +169,7 @@ public function tupleWithMultipleEmptyComponents() {
     }
 
     /**
-     * Bind statment with an null tuple
+     * Bind statement with an null tuple
      *
      * @test
      * @ticket PHP-58
diff --git a/tests/integration/Cassandra/UserTypeIntegrationTest.php b/tests/integration/Cassandra/UserTypeIntegrationTest.php
@@ -334,7 +334,7 @@ public function userTypeWithMultipleComponents() {
     }
 
     /**
-     * Bind statment with an empty user type
+     * Bind statement with an empty user type
      *
      * @test
      * @ticket PHP-58
@@ -361,7 +361,7 @@ public function userTypeWithMultipleEmptyComponents() {
     }
 
     /**
-     * Bind statment with an null user type
+     * Bind statement with an null user type
      *
      * @test
      * @ticket PHP-58

Original file line number	Diff line number	Diff line change
`@@ -253,7 +253,7 @@ public function withTimestampGenerator($generator) {}`
`253`	`253`	`* routing and $session->schema() will always return an empty object. This`
`254`	`254`	`* can be useful for reducing the startup overhead of short-lived sessions.`
`255`	`255`	`*`
`256`		`- * @param bool $enabled whether the driver fetches and maintains schema metadata.`
	`256`	`+ * @param bool $enable whether the driver fetches and maintains schema metadata.`
`257`	`257`	`*`
`258`	`258`	`* @return Builder self`
`259`	`259`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`* The default retry policy. This policy retries a query, using the`
`25`	`25`	`* request's original consistency level, in the following cases:`
`26`	`26`	`*`
`27`		`- * * On a read timeout, if enough replicas replied but the data was not recieved.`
	`27`	`+ * * On a read timeout, if enough replicas replied but the data was not received.`
`28`	`28`	`* * On a write timeout, if a timeout occurs while writing a distributed batch log.`
`29`	`29`	`* * On unavailable, it will move to the next host.`
`30`	`30`	`*`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`use Cassandra\RetryPolicy;`
`22`	`22`
`23`	`23`	`/**`
`24`		`- * A retry policy that never retries and allows all errors to fallthough.`
	`24`	`+ * A retry policy that never retries and allows all errors to fallthrough.`
`25`	`25`	`*/`
`26`	`26`	`final class Fallthrough implements RetryPolicy`
`27`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ final class Logging implements RetryPolicy`
`28`	`28`	`/**`
`29`	`29`	`* Creates a new Logging retry policy.`
`30`	`30`	`*`
`31`		`- * @param Cassandra\RetryPolicy $childPolicy Any retry poilcy other than`
	`31`	`+ * @param Cassandra\RetryPolicy $childPolicy Any retry policy other than`
`32`	`32`	`* Cassandra\Logging`
`33`	`33`	`*/`
`34`	`34`	`public function __construct($childPolicy) {}`
Original file line number	Diff line number	Diff line change
`@@ -144,7 +144,7 @@ public function nextPageAsync() {}`
`144`	`144`	`*`
`145`	`145`	`* @return string`
`146`	`146`	`*/`
`147`		`- public function pagingStateToken {}`
	`147`	`+ public function pagingStateToken() {}`
`148`	`148`
`149`	`149`	`/**`
`150`	`150`	`* Get the first row.`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ public function time() {}`
`50`	`50`	`/**`
`51`	`51`	`* Microtime from this timestamp`
`52`	`52`	`*`
`53`		`- * @param bool $get_as_float Whther to get this value as float`
	`53`	`+ * @param bool $get_as_float Whether to get this value as float`
`54`	`54`	`*`
`55`	`55`	`* @return float\|string Float or string representation`
`56`	`56`	`* @see microtime`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ final class Tuple implements Value, \Countable, \Iterator`
`26`	`26`	`/**`
`27`	`27`	`* Creates a new tuple with the given types.`
`28`	`28`	`*`
`29`		`- * @param array $type Array of types`
	`29`	`+ * @param array $types Array of types`
`30`	`30`	`*/`
`31`	`31`	`public function __construct($types) {}`
`32`	`32`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ final class UserTypeValue implements Value, \Countable, \Iterator`
`26`	`26`	`/**`
`27`	`27`	`* Creates a new user type value with the given name/type pairs.`
`28`	`28`	`*`
`29`		`- * @param array $type Array of types`
	`29`	`+ * @param array $types Array of types`
`30`	`30`	`*/`
`31`	`31`	`public function __construct($types) {}`
`32`	`32`