TASK: Fix / improve some comments

* Add missing throws annotation.
* Remove useless comments.
* Import namespaces used in comments.
This commit is contained in:
Daniel Siepmann 2018-12-29 18:03:14 +01:00
parent 18cb95b8e9
commit ea8b4f4538
Signed by: Daniel Siepmann
GPG key ID: 33D6629915560EF4
4 changed files with 8 additions and 6 deletions

View file

@ -26,7 +26,7 @@ use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
/**
* Container of all configurations for extension.
* Always inject this to have a single place for configuration and parsing only once.
* Always inject this to have a single place for configuration.
*/
class ConfigurationContainer implements ConfigurationContainerInterface
{
@ -39,6 +39,8 @@ class ConfigurationContainer implements ConfigurationContainerInterface
/**
* Inject settings via ConfigurationManager.
*
* @throws NoConfigurationException
*/
public function injectConfigurationManager(ConfigurationManagerInterface $configurationManager)
{

View file

@ -44,8 +44,6 @@ class DocumentFactory implements Singleton
}
/**
* Creates document from document.
*
* @throws \InvalidArgumentException If no search identifier was provided.
*/
public function getDocument(string $documentType, array $document): \Elastica\Document
@ -67,8 +65,6 @@ class DocumentFactory implements Singleton
}
/**
* Creates documents based on documents.
*
* @throws \InvalidArgumentException If no search identifier was provided.
*/
public function getDocuments(string $documentType, array $documents): array

View file

@ -21,6 +21,8 @@ namespace Codappix\SearchCore\Connection\Elasticsearch;
* 02110-1301, USA.
*/
use Codappix\SearchCore\Connection\FacetInterface;
use Codappix\SearchCore\Connection\ResultItemInterface;
use Codappix\SearchCore\Connection\SearchRequestInterface;
use Codappix\SearchCore\Connection\SearchResultInterface;
use Codappix\SearchCore\Domain\Model\QueryResultInterfaceStub;

View file

@ -29,7 +29,9 @@ use Codappix\SearchCore\Connection\SearchResultInterface;
*/
interface SearchServiceInterface
{
/**
* Fetches result for provided search request.
*/
public function search(SearchRequestInterface $searchRequest): SearchResultInterface;
/**