Commit 4f4fe388 authored by Bas de Nooijer's avatar Bas de Nooijer

Removed @internal from phpdoc as this in some editors shows the API methods as...

Removed @internal from phpdoc as this in some editors shows the API methods as internal. The annotation was only intended for internal comments, but as this is not very important they are 'normal' comments now.
parent 099f57ca
...@@ -95,8 +95,8 @@ class Client extends CoreClient ...@@ -95,8 +95,8 @@ class Client extends CoreClient
* - 1.2.4 (higher) * - 1.2.4 (higher)
* *
* *
* @internal a string compare is used instead of version_compare because * A string compare is used instead of version_compare because
* version_compare returns false for a compare of 1.0.0 with 1.0 * version_compare returns false for a compare of 1.0.0 with 1.0
* *
* @param string $version * @param string $version
* *
......
...@@ -799,6 +799,9 @@ class Client extends Configurable ...@@ -799,6 +799,9 @@ class Client extends Configurable
/** /**
* Execute a ping query. * Execute a ping query.
* *
* This is a convenience method that forwards the query to the
* execute method, thus allowing for an easy to use and clean API.
*
* Example usage: * Example usage:
* <code> * <code>
* $client = new Solarium\Client; * $client = new Solarium\Client;
...@@ -808,9 +811,6 @@ class Client extends Configurable ...@@ -808,9 +811,6 @@ class Client extends Configurable
* *
* @see Solarium\QueryType\Ping * @see Solarium\QueryType\Ping
* *
* @internal This is a convenience method that forwards the query to the
* execute method, thus allowing for an easy to use and clean API.
*
* @param QueryInterface|\Solarium\QueryType\Ping\Query $query * @param QueryInterface|\Solarium\QueryType\Ping\Query $query
* @param Endpoint|string|null $endpoint * @param Endpoint|string|null $endpoint
* *
...@@ -824,6 +824,9 @@ class Client extends Configurable ...@@ -824,6 +824,9 @@ class Client extends Configurable
/** /**
* Execute an update query. * Execute an update query.
* *
* This is a convenience method that forwards the query to the
* execute method, thus allowing for an easy to use and clean API.
*
* Example usage: * Example usage:
* <code> * <code>
* $client = new Solarium\Client; * $client = new Solarium\Client;
...@@ -835,9 +838,6 @@ class Client extends Configurable ...@@ -835,9 +838,6 @@ class Client extends Configurable
* @see Solarium\QueryType\Update * @see Solarium\QueryType\Update
* @see Solarium\Result\Update * @see Solarium\Result\Update
* *
* @internal This is a convenience method that forwards the query to the
* execute method, thus allowing for an easy to use and clean API.
*
* @param QueryInterface|\Solarium\QueryType\Update\Query\Query $query * @param QueryInterface|\Solarium\QueryType\Update\Query\Query $query
* @param Endpoint|string|null $endpoint * @param Endpoint|string|null $endpoint
* *
...@@ -851,6 +851,9 @@ class Client extends Configurable ...@@ -851,6 +851,9 @@ class Client extends Configurable
/** /**
* Execute a select query. * Execute a select query.
* *
* This is a convenience method that forwards the query to the
* execute method, thus allowing for an easy to use and clean API.
*
* Example usage: * Example usage:
* <code> * <code>
* $client = new Solarium\Client; * $client = new Solarium\Client;
...@@ -861,9 +864,6 @@ class Client extends Configurable ...@@ -861,9 +864,6 @@ class Client extends Configurable
* @see Solarium\QueryType\Select * @see Solarium\QueryType\Select
* @see Solarium\Result\Select * @see Solarium\Result\Select
* *
* @internal This is a convenience method that forwards the query to the
* execute method, thus allowing for an easy to use and clean API.
*
* @param QueryInterface|\Solarium\QueryType\Select\Query\Query $query * @param QueryInterface|\Solarium\QueryType\Select\Query\Query $query
* @param Endpoint|string|null $endpoint * @param Endpoint|string|null $endpoint
* *
...@@ -877,6 +877,9 @@ class Client extends Configurable ...@@ -877,6 +877,9 @@ class Client extends Configurable
/** /**
* Execute a MoreLikeThis query. * Execute a MoreLikeThis query.
* *
* This is a convenience method that forwards the query to the
* execute method, thus allowing for an easy to use and clean API.
*
* Example usage: * Example usage:
* <code> * <code>
* $client = new Solarium\Client; * $client = new Solarium\Client;
...@@ -887,9 +890,6 @@ class Client extends Configurable ...@@ -887,9 +890,6 @@ class Client extends Configurable
* @see Solarium\QueryType\MoreLikeThis * @see Solarium\QueryType\MoreLikeThis
* @see Solarium\Result\MoreLikeThis * @see Solarium\Result\MoreLikeThis
* *
* @internal This is a convenience method that forwards the query to the
* execute method, thus allowing for an easy to use and clean API.
*
* @param QueryInterface|\Solarium\QueryType\MoreLikeThis\Query $query * @param QueryInterface|\Solarium\QueryType\MoreLikeThis\Query $query
* @param Endpoint|string|null $endpoint * @param Endpoint|string|null $endpoint
* *
...@@ -903,8 +903,8 @@ class Client extends Configurable ...@@ -903,8 +903,8 @@ class Client extends Configurable
/** /**
* Execute an analysis query. * Execute an analysis query.
* *
* @internal This is a convenience method that forwards the query to the * This is a convenience method that forwards the query to the
* execute method, thus allowing for an easy to use and clean API. * execute method, thus allowing for an easy to use and clean API.
* *
* @param QueryInterface|\Solarium\QueryType\Analysis\Query\Document|\Solarium\QueryType\Analysis\Query\Field $query * @param QueryInterface|\Solarium\QueryType\Analysis\Query\Document|\Solarium\QueryType\Analysis\Query\Field $query
* @param Endpoint|string|null $endpoint * @param Endpoint|string|null $endpoint
...@@ -919,8 +919,8 @@ class Client extends Configurable ...@@ -919,8 +919,8 @@ class Client extends Configurable
/** /**
* Execute a terms query. * Execute a terms query.
* *
* @internal This is a convenience method that forwards the query to the * This is a convenience method that forwards the query to the
* execute method, thus allowing for an easy to use and clean API. * execute method, thus allowing for an easy to use and clean API.
* *
* @param QueryInterface|\Solarium\QueryType\Terms\Query $query * @param QueryInterface|\Solarium\QueryType\Terms\Query $query
* @param Endpoint|string|null $endpoint * @param Endpoint|string|null $endpoint
...@@ -935,8 +935,8 @@ class Client extends Configurable ...@@ -935,8 +935,8 @@ class Client extends Configurable
/** /**
* Execute a suggester query. * Execute a suggester query.
* *
* @internal This is a convenience method that forwards the query to the * This is a convenience method that forwards the query to the
* execute method, thus allowing for an easy to use and clean API. * execute method, thus allowing for an easy to use and clean API.
* *
* @param QueryInterface|\Solarium\QueryType\Suggester\Query $query * @param QueryInterface|\Solarium\QueryType\Suggester\Query $query
* @param Endpoint|string|null $endpoint * @param Endpoint|string|null $endpoint
...@@ -951,8 +951,8 @@ class Client extends Configurable ...@@ -951,8 +951,8 @@ class Client extends Configurable
/** /**
* Execute an extract query. * Execute an extract query.
* *
* @internal This is a convenience method that forwards the query to the * This is a convenience method that forwards the query to the
* execute method, thus allowing for an easy to use and clean API. * execute method, thus allowing for an easy to use and clean API.
* *
* @param QueryInterface|\Solarium\QueryType\Extract\Query $query * @param QueryInterface|\Solarium\QueryType\Extract\Query $query
* @param Endpoint|string|null $endpoint * @param Endpoint|string|null $endpoint
...@@ -967,8 +967,8 @@ class Client extends Configurable ...@@ -967,8 +967,8 @@ class Client extends Configurable
/** /**
* Execute a RealtimeGet query. * Execute a RealtimeGet query.
* *
* @internal This is a convenience method that forwards the query to the * This is a convenience method that forwards the query to the
* execute method, thus allowing for an easy to use and clean API. * execute method, thus allowing for an easy to use and clean API.
* *
* @param QueryInterface|\Solarium\QueryType\RealtimeGet\Query $query * @param QueryInterface|\Solarium\QueryType\RealtimeGet\Query $query
* @param Endpoint|string|null $endpoint * @param Endpoint|string|null $endpoint
......
...@@ -157,9 +157,9 @@ class Configurable implements ConfigurableInterface ...@@ -157,9 +157,9 @@ class Configurable implements ConfigurableInterface
* This hook is called by the constructor after saving the constructor * This hook is called by the constructor after saving the constructor
* arguments in {@link $options} * arguments in {@link $options}
* *
* @internal This empty implementation can optionally be implemented in * This empty implementation can optionally be implemented in
* descending classes. It's not an abstract method on purpose, there are * descending classes. It's not an abstract method on purpose, there are
* many cases where no initialization is needed. * many cases where no initialization is needed.
*/ */
protected function init() protected function init()
{ {
......
...@@ -48,8 +48,8 @@ use Solarium\Core\Query\Result\QueryType as BaseResult; ...@@ -48,8 +48,8 @@ use Solarium\Core\Query\Result\QueryType as BaseResult;
* An update query only returns a query time and status. Both are accessible * An update query only returns a query time and status. Both are accessible
* using the methods provided by {@link Solarium\Result\Query}. * using the methods provided by {@link Solarium\Result\Query}.
* *
* @internal For now this class only exists to distinguish the different result * For now this class only exists to distinguish the different result
* types. It might get some extra behaviour in the future. * types. It might get some extra behaviour in the future.
*/ */
class Result extends BaseResult class Result extends BaseResult
{ {
......
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