Commit 92a1d2c9 authored by Dorian Villet's avatar Dorian Villet

Improve PHPDocs (adding missing @throws, @return etc).

parent 7bc75218
...@@ -135,7 +135,8 @@ class PeclHttp extends Configurable implements AdapterInterface ...@@ -135,7 +135,8 @@ class PeclHttp extends Configurable implements AdapterInterface
* @throws InvalidArgumentException * @throws InvalidArgumentException
* @param Request $request * @param Request $request
* @param Endpoint $endpoint * @param Endpoint $endpoint
* @param HttpRequest * @param HttpRequest
* @return \HttpRequest
*/ */
public function toHttpRequest($request, $endpoint) public function toHttpRequest($request, $endpoint)
{ {
......
...@@ -161,6 +161,7 @@ class ZendHttp extends Configurable implements AdapterInterface ...@@ -161,6 +161,7 @@ class ZendHttp extends Configurable implements AdapterInterface
* Execute a Solr request using the Zend_Http_Client instance * Execute a Solr request using the Zend_Http_Client instance
* *
* @throws HttpException * @throws HttpException
* @throws OutOfBoundsException
* @param Request $request * @param Request $request
* @param Endpoint $endpoint * @param Endpoint $endpoint
* @return Response * @return Response
...@@ -210,6 +211,7 @@ class ZendHttp extends Configurable implements AdapterInterface ...@@ -210,6 +211,7 @@ class ZendHttp extends Configurable implements AdapterInterface
* Prepare a solarium response from the given request and client * Prepare a solarium response from the given request and client
* response * response
* *
* @throws HttpException
* @param Request $request * @param Request $request
* @param \Zend_Http_Response $response * @param \Zend_Http_Response $response
* @return Response * @return Response
......
...@@ -324,6 +324,7 @@ class Request extends Configurable ...@@ -324,6 +324,7 @@ class Request extends Configurable
/** /**
* Set the file to upload via "multipart/form-data" POST request * Set the file to upload via "multipart/form-data" POST request
* *
* @throws RuntimeException
* @param string $filename Name of file to upload * @param string $filename Name of file to upload
* @return self * @return self
*/ */
......
...@@ -136,7 +136,8 @@ class Result implements ResultInterface ...@@ -136,7 +136,8 @@ class Result implements ResultInterface
* *
* Includes a lazy loading mechanism: JSON body data is decoded on first use and then saved for reuse. * Includes a lazy loading mechanism: JSON body data is decoded on first use and then saved for reuse.
* *
* @throws UnexpectedValueException, RuntimeException * @throws UnexpectedValueException
* @throws RuntimeException
* @return array * @return array
*/ */
public function getData() public function getData()
......
...@@ -484,6 +484,7 @@ class Loadbalancer extends Plugin ...@@ -484,6 +484,7 @@ class Loadbalancer extends Plugin
/** /**
* Execute a request using the adapter * Execute a request using the adapter
* *
* @throws RuntimeException
* @param Request $request * @param Request $request
* @return Response $response * @return Response $response
*/ */
......
...@@ -58,7 +58,8 @@ class RequestBuilder extends BaseRequestBuilder ...@@ -58,7 +58,8 @@ class RequestBuilder extends BaseRequestBuilder
/** /**
* Build the request * Build the request
* *
* @param Query $query * @throws RuntimeException
* @param Query|QueryInterface $query
* @return Request * @return Request
*/ */
public function build(QueryInterface $query) public function build(QueryInterface $query)
......
...@@ -391,6 +391,7 @@ class Document extends AbstractDocument implements DocumentInterface ...@@ -391,6 +391,7 @@ class Document extends AbstractDocument implements DocumentInterface
* *
* Adds validation for atomicUpdates * Adds validation for atomicUpdates
* *
* @throws RuntimeException
* @return array * @return array
*/ */
public function getFields() public function getFields()
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment