Regenerate PHP API docs

Author: mpenick

ext/doc/Cassandra.php

@@ -29,31 +29,31 @@ final class Cassandra {
      * has been written on the Coordinator. Requests with this consistency level
      * are not guranteed to make it to Replica nodes.
      *
-     * @see ExecutionOptions::__construct()
+     * @see Session::execute()
      */
     const CONSISTENCY_ANY = 0;
 
     /**
      * Consistency level ONE guarantees that data has been written to at least
      * one Replica node.
      *
-     * @see ExecutionOptions::__construct()
+     * @see Session::execute()
      */
     const CONSISTENCY_ONE = 1;
 
     /**
      * Consistency level TWO guarantees that data has been written to at least
      * two Replica nodes.
      *
-     * @see ExecutionOptions::__construct()
+     * @see Session::execute()
      */
     const CONSISTENCY_TWO = 2;
 
     /**
      * Consistency level THREE guarantees that data has been written to at least
      * three Replica nodes.
      *
-     * @see ExecutionOptions::__construct()
+     * @see Session::execute()
      */
     const CONSISTENCY_THREE = 3;
 
@@ -65,23 +65,23 @@ final class Cassandra {
      * ceiling function and `RF` is the replication factor used. For example,
      * for a replication factor of `5`, the majority is `ceil(5 / 2 + 1) = 3`.
      *
-     * @see ExecutionOptions::__construct()
+     * @see Session::execute()
      */
     const CONSISTENCY_QUORUM = 4;
 
     /**
      * Consistency level ALL guarantees that data has been written to all
      * Replica nodes.
      *
-     * @see ExecutionOptions::__construct()
+     * @see Session::execute()
      */
     const CONSISTENCY_ALL = 5;
 
     /**
      * Same as `CONSISTENCY_QUORUM`, but confined to the local data center. This
      * consistency level works only with `NetworkTopologyStrategy` replication.
      *
-     * @see ExecutionOptions::__construct()
+     * @see Session::execute()
      */
     const CONSISTENCY_LOCAL_QUORUM = 6;
 
@@ -90,35 +90,36 @@ final class Cassandra {
      * least a majority Replica nodes in all datacenters. This consistency level
      * works only with `NetworkTopologyStrategy` replication.
      *
-     * @see ExecutionOptions::__construct()
+     * @see Session::execute()
      */
     const CONSISTENCY_EACH_QUORUM = 7;
 
     /**
      * This is a serial consistency level, it is used in conditional updates,
      * e.g. (`CREATE|INSERT ... IF NOT EXISTS`), and should be specified as the
-     * `serial_consistency` option of the ExecutionOptions instance.
+     * `serial_consistency` execution option when invoking `session.execute`
+     * or `session.execute_async`.
      *
      * Consistency level SERIAL, when set, ensures that a Paxos commit fails if
      * any of the replicas is down.
      *
-     * @see ExecutionOptions::__construct()
+     * @see Session::execute()
      */
     const CONSISTENCY_SERIAL = 8;
 
     /**
      * Same as `CONSISTENCY_SERIAL`, but confined to the local data center. This
      * consistency level works only with `NetworkTopologyStrategy` replication.
      *
-     * @see ExecutionOptions::__construct()
+     * @see Session::execute()
      */
     const CONSISTENCY_LOCAL_SERIAL = 9;
 
     /**
      * Same as `CONSISTENCY_ONE`, but confined to the local data center. This
      * consistency level works only with `NetworkTopologyStrategy` replication.
      *
-     * @see ExecutionOptions::__construct()
+     * @see Session::execute()
      */
     const CONSISTENCY_LOCAL_ONE = 10;
 
@@ -378,12 +379,12 @@ final class Cassandra {
     /**
      * The current version of the extension.
      */
-    const VERSION = '1.3.0-devel';
+    const VERSION = '1.3.0';
 
     /**
      * The version of the cpp-driver the extension is compiled against.
      */
-    const CPP_DRIVER_VERSION = '2.6.0-dev';
+    const CPP_DRIVER_VERSION = '2.7.0';
 
     /**
      * Creates a new cluster builder for constructing a Cluster object.

ext/doc/Cassandra/DefaultAggregate.php

@@ -24,63 +24,63 @@
 final class DefaultAggregate implements Aggregate {
 
     /**
-     * {@inheritDoc}
+     * Returns the full name of the aggregate
      *
      * @return string Full name of the aggregate including name and types
      */
     public function name() { }
 
     /**
-     * {@inheritDoc}
+     * Returns the simple name of the aggregate
      *
      * @return string Simple name of the aggregate
      */
     public function simpleName() { }
 
     /**
-     * {@inheritDoc}
+     * Returns the argument types of the aggregate
      *
      * @return array Argument types of the aggregate
      */
     public function argumentTypes() { }
 
     /**
-     * {@inheritDoc}
+     * Returns the state function of the aggregate
      *
      * @return Function State public function of the aggregate
      */
     public function stateFunction() { }
 
     /**
-     * {@inheritDoc}
+     * Returns the final function of the aggregate
      *
      * @return Function Final public function of the aggregate
      */
     public function finalFunction() { }
 
     /**
-     * {@inheritDoc}
+     * Returns the initial condition of the aggregate
      *
      * @return Value Initial condition of the aggregate
      */
     public function initialCondition() { }
 
     /**
-     * {@inheritDoc}
+     * Returns the state type of the aggregate
      *
      * @return Type State type of the aggregate
      */
     public function stateType() { }
 
     /**
-     * {@inheritDoc}
+     * Returns the return type of the aggregate
      *
      * @return Type Return type of the aggregate
      */
     public function returnType() { }
 
     /**
-     * {@inheritDoc}
+     * Returns the signature of the aggregate
      *
      * @return string Signature of the aggregate (same as name())
      */

ext/doc/Cassandra/DefaultCluster.php

@@ -26,7 +26,7 @@
 final class DefaultCluster implements Cluster {
 
     /**
-     * {@inheritDoc}
+     * Creates a new Session instance.
      *
      * @param string $keyspace Optional keyspace name
      * @param int $timeout Optional timeout
@@ -36,7 +36,7 @@ final class DefaultCluster implements Cluster {
     public function connect($keyspace, $timeout) { }
 
     /**
-     * {@inheritDoc}
+     * Creates a new Session instance.
      *
      * @param string $keyspace Optional keyspace name
      *

ext/doc/Cassandra/DefaultColumn.php

@@ -24,49 +24,49 @@
 final class DefaultColumn implements Column {
 
     /**
-     * {@inheritDoc}
+     * Returns the name of the column.
      *
      * @return string Name of the column or null
      */
     public function name() { }
 
     /**
-     * {@inheritDoc}
+     * Returns the type of the column.
      *
      * @return Type Type of the column
      */
     public function type() { }
 
     /**
-     * {@inheritDoc}
+     * Returns whether the column is in descending or ascending order.
      *
      * @return bool Whether the column is stored in descending order.
      */
     public function isReversed() { }
 
     /**
-     * {@inheritDoc}
+     * Returns true for static columns.
      *
      * @return bool Whether the column is static
      */
     public function isStatic() { }
 
     /**
-     * {@inheritDoc}
+     * Returns true for frozen columns.
      *
      * @return bool Whether the column is frozen
      */
     public function isFrozen() { }
 
     /**
-     * {@inheritDoc}
+     * Returns name of the index if defined.
      *
      * @return string Name of the index if defined or null
      */
     public function indexName() { }
 
     /**
-     * {@inheritDoc}
+     * Returns index options if present.
      *
      * @return string Index options if present or null
      */

ext/doc/Cassandra/DefaultFunction.php

@@ -24,58 +24,58 @@
 final class DefaultFunction implements Function_ {
 
     /**
-     * {@inheritDoc}
+     * Returns the full name of the function
      *
      * @return string Full name of the function including name and types
      */
     public function name() { }
 
     /**
-     * {@inheritDoc}
+     * Returns the simple name of the function
      *
      * @return string Simple name of the function
      */
     public function simpleName() { }
 
     /**
-     * {@inheritDoc}
+     * Returns the arguments of the function
      *
      * @return array Arguments of the function
      */
     public function arguments() { }
 
     /**
-     * {@inheritDoc}
+     * Returns the return type of the function
      *
      * @return Type Return type of the function
      */
     public function returnType() { }
 
     /**
-     * {@inheritDoc}
+     * Returns the signature of the function
      *
      * @return string Signature of the function (same as name())
      */
     public function signature() { }
 
     /**
-     * {@inheritDoc}
+     * Returns the lanuage of the function
      *
      * @return string Language used by the function
      */
     public function language() { }
 
     /**
-     * {@inheritDoc}
+     * Returns the body of the function
      *
      * @return string Body of the function
      */
     public function body() { }
 
     /**
-     * {@inheritDoc}
+     * Determines if a function is called when the value is null.
      *
-     * @return bool
+     * @return bool Returns whether the function is called when the input columns are null
      */
     public function isCalledOnNullInput() { }
 

ext/doc/Cassandra/DefaultIndex.php

@@ -24,53 +24,53 @@
 final class DefaultIndex implements Index {
 
     /**
-     * {@inheritDoc}
+     * Returns the name of the index
      *
      * @return string Name of the index
      */
     public function name() { }
 
     /**
-     * {@inheritDoc}
+     * Returns the kind of index
      *
      * @return string Kind of the index
      */
     public function kind() { }
 
     /**
-     * {@inheritDoc}
+     * Returns the target column of the index
      *
      * @return string Target column name of the index
      */
     public function target() { }
 
     /**
-     * {@inheritDoc}
+     * Return a column's option by name
      *
-     * @param string $name {@inheritDoc}
+     * @param string $name The name of the option
      *
      * @return Value Value of an option by name
      */
     public function option($name) { }
 
     /**
-     * {@inheritDoc}
+     * Returns all the index's options
      *
-     * @return array A dictionary of `string` and `Value` pairs of the
+     * @return array A dictionary of `string` and `Value` pairs of the index's options.
      */
     public function options() { }
 
     /**
-     * {@inheritDoc}
+     * Returns the class name of the index
      *
      * @return string Class name of a custom index
      */
     public function className() { }
 
     /**
-     * {@inheritDoc}
+     * Determines if the index is a custom index.
      *
-     * @return bool
+     * @return bool true if a custom index
      */
     public function isCustom() { }