Fixed PHPDocumentation

holtkamp · holtkamp · commit a6fcf13e0bde · 2014-06-20T00:19:18.000+02:00
Our application was expecting a boolean to be returned by the auth() function. However, this seems to have been changed overtime. How is determined whether an authentication is successful? It seems the only way is to use 'checkToken()' after authentication. 

It would be better to have 'setToken()' return a boolean, however this might break other stuff that depends on the $this being returned now...
diff --git a/CloudControl/API.php b/CloudControl/API.php
@@ -120,7 +120,7 @@ public function requiresToken() {
      * @throws ThrottledError
      * @throws CCException
      *
-     * @return boolean
+     * @return $this
      */
     public function auth($email, $password) {
         $request = new Request($this->_url);
@@ -150,7 +150,7 @@ public function checkToken($token) {
      *
      * @param string $token token to set
      *
-     * @return void
+     * @return $this
      */
     public function setToken($token) {
         if ($this->checkToken($token)) {

Original file line number	Diff line number	Diff line change
`@@ -120,7 +120,7 @@ public function requiresToken() {`
`120`	`120`	`* @throws ThrottledError`
`121`	`121`	`* @throws CCException`
`122`	`122`	`*`
`123`		`- * @return boolean`
	`123`	`+ * @return $this`
`124`	`124`	`*/`
`125`	`125`	`public function auth($email, $password) {`
`126`	`126`	`$request = new Request($this->_url);`
`@@ -150,7 +150,7 @@ public function checkToken($token) {`
`150`	`150`	`*`
`151`	`151`	`* @param string $token token to set`
`152`	`152`	`*`
`153`		`- * @return void`
	`153`	`+ * @return $this`
`154`	`154`	`*/`
`155`	`155`	`public function setToken($token) {`
`156`	`156`	`if ($this->checkToken($token)) {`