Fixed phpdoc for create index functions.

F21 · F21 · commit a2ae1d262ba6 · 2013-04-23T13:29:10.000+10:00
diff --git a/lib/triagens/ArangoDb/CollectionHandler.php b/lib/triagens/ArangoDb/CollectionHandler.php
@@ -429,7 +429,7 @@ public function create($collection, $options = array())
      * @param int $size - the size of the cap constraint
      * @link http://www.arangodb.org/manuals/current/IndexCapHttp.html
      *
-     * @return mixed - id of collection created
+     * @return array - server response of the created index
      */
     public function createCapConstraint($collectionId, $size)
     {
@@ -450,7 +450,7 @@ public function createCapConstraint($collectionId, $size)
      * @param boolean $ignoreNull - whether to ignore null
      * @link http://www.arangodb.org/manuals/current/IndexGeoHttp.html
      *
-     * @return mixed - id of collection created
+     * @return array - server response of the created index
      */
     public function createGeoIndex($collectionId, array $fields, $geoJson = null, $constraint = null, $ignoreNull = null)
     {
@@ -479,7 +479,7 @@ public function createGeoIndex($collectionId, array $fields, $geoJson = null, $c
      * @param boolean $unique - whether the values in the index should be unique or not
      * @link http://www.arangodb.org/manuals/current/IndexHashHttp.html
      *
-     * @return mixed - id of collection created
+     * @return array - server response of the created index
      */
     public function createHashIndex($collectionId, array $fields, $unique = null)
     {
@@ -500,7 +500,7 @@ public function createHashIndex($collectionId, array $fields, $unique = null)
      * @param int $minLength - the minimum length of words to index
      * @link http://www.arangodb.org/manuals/current/IndexFulltextHttp.html
      *
-     * @return mixed - id of collection created
+     * @return array - server response of the created index
      */
     public function createFulltextIndex($collectionId, array $fields, $minLength = null)
     {
@@ -521,7 +521,7 @@ public function createFulltextIndex($collectionId, array $fields, $minLength = n
      * @param bool $unique - whether the index is unique or not
      * @link http://www.arangodb.org/manuals/current/IndexSkiplistHttp.html
      *
-     * @return mixed - id of collection created
+     * @return array - server response of the created index
      */
     public function createSkipListIndex($collectionId, array $fields, $unique = null)
     {
@@ -549,7 +549,7 @@ public function createSkipListIndex($collectionId, array $fields, $unique = null
      * @param bool    $unique       - true/false to create a unique index
      * @param array   $indexOptions - an associative array of options for the index like array('geoJson' => true)
      *
-     * @return mixed - id of collection created
+     * @return array - server response of the created index
      */
     public function index($collectionId, $type = "", $attributes = array(), $unique = false, $indexOptions = array())
     {

Original file line number	Diff line number	Diff line change
`@@ -429,7 +429,7 @@ public function create($collection, $options = array())`
`429`	`429`	`* @param int $size - the size of the cap constraint`
`430`	`430`	`* @link http://www.arangodb.org/manuals/current/IndexCapHttp.html`
`431`	`431`	`*`
`432`		`- * @return mixed - id of collection created`
	`432`	`+ * @return array - server response of the created index`
`433`	`433`	`*/`
`434`	`434`	`public function createCapConstraint($collectionId, $size)`
`435`	`435`	`{`
`@@ -450,7 +450,7 @@ public function createCapConstraint($collectionId, $size)`
`450`	`450`	`* @param boolean $ignoreNull - whether to ignore null`
`451`	`451`	`* @link http://www.arangodb.org/manuals/current/IndexGeoHttp.html`
`452`	`452`	`*`
`453`		`- * @return mixed - id of collection created`
	`453`	`+ * @return array - server response of the created index`
`454`	`454`	`*/`
`455`	`455`	`public function createGeoIndex($collectionId, array $fields, $geoJson = null, $constraint = null, $ignoreNull = null)`
`456`	`456`	`{`
`@@ -479,7 +479,7 @@ public function createGeoIndex($collectionId, array $fields, $geoJson = null, $c`
`479`	`479`	`* @param boolean $unique - whether the values in the index should be unique or not`
`480`	`480`	`* @link http://www.arangodb.org/manuals/current/IndexHashHttp.html`
`481`	`481`	`*`
`482`		`- * @return mixed - id of collection created`
	`482`	`+ * @return array - server response of the created index`
`483`	`483`	`*/`
`484`	`484`	`public function createHashIndex($collectionId, array $fields, $unique = null)`
`485`	`485`	`{`
`@@ -500,7 +500,7 @@ public function createHashIndex($collectionId, array $fields, $unique = null)`
`500`	`500`	`* @param int $minLength - the minimum length of words to index`
`501`	`501`	`* @link http://www.arangodb.org/manuals/current/IndexFulltextHttp.html`
`502`	`502`	`*`
`503`		`- * @return mixed - id of collection created`
	`503`	`+ * @return array - server response of the created index`
`504`	`504`	`*/`
`505`	`505`	`public function createFulltextIndex($collectionId, array $fields, $minLength = null)`
`506`	`506`	`{`
`@@ -521,7 +521,7 @@ public function createFulltextIndex($collectionId, array $fields, $minLength = n`
`521`	`521`	`* @param bool $unique - whether the index is unique or not`
`522`	`522`	`* @link http://www.arangodb.org/manuals/current/IndexSkiplistHttp.html`
`523`	`523`	`*`
`524`		`- * @return mixed - id of collection created`
	`524`	`+ * @return array - server response of the created index`
`525`	`525`	`*/`
`526`	`526`	`public function createSkipListIndex($collectionId, array $fields, $unique = null)`
`527`	`527`	`{`
`@@ -549,7 +549,7 @@ public function createSkipListIndex($collectionId, array $fields, $unique = null`
`549`	`549`	`* @param bool $unique - true/false to create a unique index`
`550`	`550`	`* @param array $indexOptions - an associative array of options for the index like array('geoJson' => true)`
`551`	`551`	`*`
`552`		`- * @return mixed - id of collection created`
	`552`	`+ * @return array - server response of the created index`
`553`	`553`	`*/`
`554`	`554`	`public function index($collectionId, $type = "", $attributes = array(), $unique = false, $indexOptions = array())`
`555`	`555`	`{`