PHP-145 - Add API doc generator system

Generated PHP API docs

Author: mpenick

ext/doc/Cassandra.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2015-2016 DataStax, Inc.
+ * Copyright 2017 DataStax, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,59 +21,69 @@
 /**
  * A PHP representation of an aggregate
  */
-interface Aggregate
-{
+interface Aggregate {
+
     /**
      * Returns the full name of the aggregate
+     *
      * @return string Full name of the aggregate including name and types
      */
-    function name();
+    public function name();
 
     /**
      * Returns the simple name of the aggregate
+     *
      * @return string Simple name of the aggregate
      */
-    function simpleName();
+    public function simpleName();
 
     /**
      * Returns the argument types of the aggregate
+     *
      * @return array Argument types of the aggregate
      */
-    function argumentTypes();
+    public function argumentTypes();
 
     /**
      * Returns the final function of the aggregate
-     * @return Cassandra\Function Final function of the aggregate
+     *
+     * @return Function Final function of the aggregate
      */
-    function finalFunction();
+    public function finalFunction();
 
     /**
      * Returns the state function of the aggregate
-     * @return Cassandra\Function State function of the aggregate
+     *
+     * @return Function State function of the aggregate
      */
-    function stateFunction();
+    public function stateFunction();
 
     /**
      * Returns the initial condition of the aggregate
-     * @return Cassandra\Value Initial condition of the aggregate
+     *
+     * @return Value Initial condition of the aggregate
      */
-    function initialCondition();
+    public function initialCondition();
 
     /**
      * Returns the return type of the aggregate
-     * @return Cassandra\Type Return type of the aggregate
+     *
+     * @return Type Return type of the aggregate
      */
-    function returnType();
+    public function returnType();
 
     /**
      * Returns the state type of the aggregate
-     * @return Cassandra\Type State type of the aggregate
+     *
+     * @return Type State type of the aggregate
      */
-    function stateType();
+    public function stateType();
 
     /**
      * Returns the signature of the aggregate
+     *
      * @return string Signature of the aggregate (same as name())
      */
-    function signature();
+    public function signature();
+
 }

ext/doc/Cassandra/Aggregate.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2015-2016 DataStax, Inc.
+ * Copyright 2017 DataStax, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -37,24 +37,25 @@
  * @see Cassandra::BATCH_UNLOGGED
  * @see Cassandra::BATCH_COUNTER
  */
-final class BatchStatement implements Statement
-{
+final class BatchStatement implements Statement {
+
     /**
      * Creates a new batch statement.
      *
      * @param int $type must be one of Cassandra::BATCH_* (default: Cassandra::BATCH_LOGGED).
      */
-    public function __construct($type = \Cassandra::BATCH_LOGGED) {}
+    public function __construct($type) { }
 
     /**
      * Adds a statement to this batch.
      *
      * @param string|Statement $statement string or statement to add
-     * @param array|null $arguments positional or named arguments
+     * @param array|null $arguments positional or named arguments (optional)
      *
      * @throws Exception\InvalidArgumentException
      *
      * @return BatchStatement self
      */
-    public function add($statement, array $arguments = null) {}
+    public function add($statement, $arguments) { }
+
 }

ext/doc/Cassandra/BatchStatement.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2015-2016 DataStax, Inc.
+ * Copyright 2017 DataStax, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,107 +21,103 @@
 /**
  * A PHP representation of the CQL `bigint` datatype
  */
-final class Bigint implements Value, Numeric
-{
-    /**
-     * Minimum possible Bigint value
-     *
-     * @return Bigint minimum value
-     */
-    public static function min() {}
+final class Bigint implements Value, Numeric {
 
     /**
-     * Maximum possible Bigint value
+     * Creates a new 64bit integer.
      *
-     * @return Bigint maximum value
+     * @param string $value integer value as a string
      */
-    public static function max() {}
+    public function __construct($value) { }
 
     /**
-     * Creates a new 64bit integer.
+     * Returns string representation of the integer value.
      *
-     * @param string $value integer value as a string
+     * @return string integer value
      */
-    public function __construct($value) {}
+    public function __toString() { }
 
     /**
      * The type of this bigint.
      *
      * @return Type
      */
-    public function type() {}
+    public function type() { }
 
     /**
      * Returns the integer value.
      *
      * @return string integer value
      */
-    public function value() {}
-
-    /**
-     * Returns string representation of the integer value.
-     *
-     * @return string integer value
-     */
-    public function __toString() {}
+    public function value() { }
 
     /**
-     * @param Numeric $addend a number to add to this one
-     *
+     * @param Numeric $num a number to add to this one
      * @return Numeric sum
      */
-    public function add(Numeric $addend) {}
+    public function add($num) { }
 
     /**
-     * @param Numeric $subtrahend a number to subtract from this one
-     *
+     * @param Numeric $num a number to subtract from this one
      * @return Numeric difference
      */
-    public function sub(Numeric $subtrahend) {}
+    public function sub($num) { }
 
     /**
-     * @param Numeric $multiplier a number to multiply this one by
-     *
+     * @param Numeric $num a number to multiply this one by
      * @return Numeric product
      */
-    public function mul(Numeric $multiplier) {}
+    public function mul($num) { }
 
     /**
-     * @param Numeric $divisor a number to divide this one by
-     *
+     * @param Numeric $num a number to divide this one by
      * @return Numeric quotient
      */
-    public function div(Numeric $divisor) {}
+    public function div($num) { }
 
     /**
-     * @param Numeric $divisor a number to divide this one by
-     *
+     * @param Numeric $num a number to divide this one by
      * @return Numeric remainder
      */
-    public function mod(Numeric $divisor) {}
+    public function mod($num) { }
 
     /**
      * @return Numeric absolute value
      */
-    public function abs() {}
+    public function abs() { }
 
     /**
      * @return Numeric negative value
      */
-    public function neg() {}
+    public function neg() { }
 
     /**
      * @return Numeric square root
      */
-    public function sqrt() {}
+    public function sqrt() { }
 
     /**
      * @return int this number as int
      */
-    public function toInt() {}
+    public function toInt() { }
 
     /**
      * @return float this number as float
      */
-    public function toDouble() {}
+    public function toDouble() { }
+
+    /**
+     * Minimum possible Bigint value
+     *
+     * @return Bigint minimum value
+     */
+    public static function min() { }
+
+    /**
+     * Maximum possible Bigint value
+     *
+     * @return Bigint maximum value
+     */
+    public static function max() { }
+
 }

ext/doc/Cassandra/Bigint.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2015-2016 DataStax, Inc.
+ * Copyright 2017 DataStax, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,40 +21,41 @@
 /**
  * A PHP representation of the CQL `blob` datatype
  */
-final class Blob implements Value
-{
+final class Blob implements Value {
+
     /**
      * Creates a new bytes array.
      *
      * @param string $bytes any bytes
      */
-    public function __construct($bytes) {}
+    public function __construct($bytes) { }
 
     /**
-     * The type of this blob.
+     * Returns bytes as a hex string.
      *
-     * @return Type
+     * @return string bytes as hexadecimal string
      */
-    public function type() {}
+    public function __toString() { }
 
     /**
-     * Returns bytes as a hex string.
+     * The type of this blob.
      *
-     * @return string bytes as hexadecimal string
+     * @return Type
      */
-    public function bytes() {}
+    public function type() { }
 
     /**
      * Returns bytes as a hex string.
      *
      * @return string bytes as hexadecimal string
      */
-    public function __toString() {}
+    public function bytes() { }
 
     /**
      * Returns bytes as a binary string.
      *
      * @return string bytes as binary string
      */
-    public function toBinaryString() {}
+    public function toBinaryString() { }
+
 }

ext/doc/Cassandra/Blob.php

@@ -1,7 +1,7 @@
 <?php
 
 /**
- * Copyright 2015-2016 DataStax, Inc.
+ * Copyright 2017 DataStax, Inc.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,16 +21,16 @@
 /**
  * Cluster object is used to create Sessions.
  */
-interface Cluster
-{
+interface Cluster {
+
     /**
      * Creates a new Session instance.
      *
      * @param string $keyspace Optional keyspace name
      *
      * @return Session Session instance
      */
-    function connect($keyspace = null);
+    public function connect($keyspace);
 
     /**
      * Creates a new Session instance.
@@ -39,5 +39,6 @@ function connect($keyspace = null);
      *
      * @return Future A Future Session instance
      */
-    function connectAsync($keyspace = null);
+    public function connectAsync($keyspace);
+
 }