Merge #282

meili-bors[bot] · norkunas · web-flow · commit 3841fb04791f · 2023-08-14T17:09:04.000Z
282: Remove useless comments r=brunoocasali a=norkunas

# Pull Request

## Related issue
Fixes #&lt;issue_number&gt;

## What does this PR do?
- ...

## PR checklist
Please check if your PR fulfills the following requirements:
- [ ] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?


Co-authored-by: Tomas &lt;norkunas.tom@gmail.com&gt;
diff --git a/src/Command/IndexCommand.php b/src/Command/IndexCommand.php
@@ -10,9 +10,6 @@
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
 
-/**
- * Class IndexCommand.
- */
 abstract class IndexCommand extends Command
 {
     private string $prefix;
diff --git a/src/Command/MeilisearchClearCommand.php b/src/Command/MeilisearchClearCommand.php
@@ -8,9 +8,6 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
-/**
- * Class MeilisearchClearCommand.
- */
 final class MeilisearchClearCommand extends IndexCommand
 {
     public static function getDefaultName(): string
diff --git a/src/Command/MeilisearchDeleteCommand.php b/src/Command/MeilisearchDeleteCommand.php
@@ -10,9 +10,6 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
-/**
- * Class MeilisearchDeleteCommand.
- */
 final class MeilisearchDeleteCommand extends IndexCommand
 {
     public static function getDefaultName(): string
diff --git a/src/Command/MeilisearchImportCommand.php b/src/Command/MeilisearchImportCommand.php
@@ -17,9 +17,6 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
-/**
- * Class MeilisearchImportCommand.
- */
 final class MeilisearchImportCommand extends IndexCommand
 {
     private const DEFAULT_RESPONSE_TIMEOUT = 5000;
diff --git a/src/DependencyInjection/MeilisearchExtension.php b/src/DependencyInjection/MeilisearchExtension.php
@@ -14,9 +14,6 @@
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 
-/**
- * Class MeilisearchExtension.
- */
 final class MeilisearchExtension extends Extension
 {
     public function load(array $configs, ContainerBuilder $container): void
diff --git a/src/Document/Aggregator.php b/src/Document/Aggregator.php
@@ -6,9 +6,6 @@
 
 use Meilisearch\Bundle\Model\Aggregator as BaseAggregator;
 
-/**
- * Class Aggregator.
- */
 abstract class Aggregator extends BaseAggregator
 {
 }
diff --git a/src/Engine.php b/src/Engine.php
@@ -7,9 +7,6 @@
 use Meilisearch\Client;
 use Meilisearch\Exceptions\ApiException;
 
-/**
- * Class Engine.
- */
 final class Engine
 {
     private Client $client;
@@ -104,7 +101,7 @@ public function remove($searchableEntities): array
     /**
      * Clear the records of an index.
      * This method enables you to delete an index’s contents (records).
-     * Will fail if the index does not exists.
+     * Will fail if the index does not exist.
      *
      * @throws ApiException
      */
diff --git a/src/Entity/Aggregator.php b/src/Entity/Aggregator.php
@@ -6,9 +6,6 @@
 
 use Meilisearch\Bundle\Model\Aggregator as BaseAggregator;
 
-/**
- * Class Aggregator.
- */
 abstract class Aggregator extends BaseAggregator
 {
 }
diff --git a/src/Exception/EntityNotFoundInObjectID.php b/src/Exception/EntityNotFoundInObjectID.php
@@ -4,9 +4,6 @@
 
 namespace Meilisearch\Bundle\Exception;
 
-/**
- * Class EntityNotFoundInObjectID.
- */
 final class EntityNotFoundInObjectID extends \LogicException
 {
 }
diff --git a/src/Exception/InvalidSettingName.php b/src/Exception/InvalidSettingName.php
@@ -4,9 +4,6 @@
 
 namespace Meilisearch\Bundle\Exception;
 
-/**
- * Class InvalidSettingName.
- */
 final class InvalidSettingName extends \LogicException
 {
 }
diff --git a/src/Exception/ObjectIdNotFoundException.php b/src/Exception/ObjectIdNotFoundException.php
@@ -4,9 +4,6 @@
 
 namespace Meilisearch\Bundle\Exception;
 
-/**
- * Class ObjectIdNotFoundException.
- */
 final class ObjectIdNotFoundException extends \LogicException
 {
 }
diff --git a/src/Exception/SearchHitsNotFoundException.php b/src/Exception/SearchHitsNotFoundException.php
@@ -4,9 +4,6 @@
 
 namespace Meilisearch\Bundle\Exception;
 
-/**
- * Class SearchHitsNotFoundException.
- */
 final class SearchHitsNotFoundException extends \LogicException
 {
 }
diff --git a/src/Exception/TaskException.php b/src/Exception/TaskException.php
@@ -4,9 +4,6 @@
 
 namespace Meilisearch\Bundle\Exception;
 
-/**
- * Class TaskException.
- */
 final class TaskException extends \LogicException
 {
 }
diff --git a/src/MeilisearchBundle.php b/src/MeilisearchBundle.php
@@ -6,9 +6,6 @@
 
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
-/**
- * Class MeilisearchBundle.
- */
 final class MeilisearchBundle extends Bundle
 {
     public const VERSION = '0.13.0';
diff --git a/src/Model/Aggregator.php b/src/Model/Aggregator.php
@@ -9,9 +9,6 @@
 use Symfony\Component\Serializer\Normalizer\NormalizableInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
-/**
- * Class Aggregator.
- */
 abstract class Aggregator implements NormalizableInterface
 {
     /**
@@ -29,8 +26,6 @@ abstract class Aggregator implements NormalizableInterface
     protected $entity;
 
     /**
-     * Aggregator constructor.
-     *
      * @param object $entity
      */
     public function __construct($entity, array $entityIdentifierValues)
diff --git a/src/SearchService.php b/src/SearchService.php
@@ -6,9 +6,6 @@
 
 use Doctrine\Persistence\ObjectManager;
 
-/**
- * Interface SearchService.
- */
 interface SearchService
 {
     public const RESULT_KEY_HITS = 'hits';
diff --git a/src/Searchable.php b/src/Searchable.php
@@ -4,9 +4,6 @@
 
 namespace Meilisearch\Bundle;
 
-/**
- * Class Searchable.
- */
 final class Searchable
 {
     public const NORMALIZATION_FORMAT = 'searchableArray';
diff --git a/src/SearchableEntity.php b/src/SearchableEntity.php
@@ -10,9 +10,6 @@
 use Symfony\Component\Serializer\Normalizer\NormalizableInterface;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
-/**
- * Class SearchableEntity.
- */
 final class SearchableEntity
 {
     private string $indexUid;
@@ -34,8 +31,6 @@ final class SearchableEntity
     private $id;
 
     /**
-     * SearchableEntity constructor.
-     *
      * @param object                $entity
      * @param ClassMetadata<object> $entityMetadata
      */
diff --git a/src/Services/MeilisearchService.php b/src/Services/MeilisearchService.php
@@ -18,9 +18,6 @@
 use Symfony\Component\PropertyAccess\PropertyAccessor;
 use Symfony\Component\Serializer\Normalizer\NormalizerInterface;
 
-/**
- * Class MeilisearchService.
- */
 final class MeilisearchService implements SearchService
 {
     private NormalizerInterface $normalizer;

Original file line number	Diff line number	Diff line change
`@@ -10,9 +10,6 @@`
`10`	`10`	`use Symfony\Component\Console\Input\InputInterface;`
`11`	`11`	`use Symfony\Component\Console\Output\OutputInterface;`
`12`	`12`
`13`		`-/**`
`14`		`- * Class IndexCommand.`
`15`		`- */`
`16`	`13`	`abstract class IndexCommand extends Command`
`17`	`14`	`{`
`18`	`15`	`private string $prefix;`
Original file line number	Diff line number	Diff line change
`@@ -8,9 +8,6 @@`
`8`	`8`	`use Symfony\Component\Console\Input\InputOption;`
`9`	`9`	`use Symfony\Component\Console\Output\OutputInterface;`
`10`	`10`
`11`		`-/**`
`12`		`- * Class MeilisearchClearCommand.`
`13`		`- */`
`14`	`11`	`final class MeilisearchClearCommand extends IndexCommand`
`15`	`12`	`{`
`16`	`13`	`public static function getDefaultName(): string`
Original file line number	Diff line number	Diff line change
`@@ -17,9 +17,6 @@`
`17`	`17`	`use Symfony\Component\Console\Input\InputOption;`
`18`	`18`	`use Symfony\Component\Console\Output\OutputInterface;`
`19`	`19`
`20`		`-/**`
`21`		`- * Class MeilisearchImportCommand.`
`22`		`- */`
`23`	`20`	`final class MeilisearchImportCommand extends IndexCommand`
`24`	`21`	`{`
`25`	`22`	`private const DEFAULT_RESPONSE_TIMEOUT = 5000;`
Original file line number	Diff line number	Diff line change
`@@ -14,9 +14,6 @@`
`14`	`14`	`use Symfony\Component\DependencyInjection\Reference;`
`15`	`15`	`use Symfony\Component\HttpKernel\DependencyInjection\Extension;`
`16`	`16`
`17`		`-/**`
`18`		`- * Class MeilisearchExtension.`
`19`		`- */`
`20`	`17`	`final class MeilisearchExtension extends Extension`
`21`	`18`	`{`
`22`	`19`	`public function load(array $configs, ContainerBuilder $container): void`
Original file line number	Diff line number	Diff line change
`@@ -6,9 +6,6 @@`
`6`	`6`
`7`	`7`	`use Meilisearch\Bundle\Model\Aggregator as BaseAggregator;`
`8`	`8`
`9`		`-/**`
`10`		`- * Class Aggregator.`
`11`		`- */`
`12`	`9`	`abstract class Aggregator extends BaseAggregator`
`13`	`10`	`{`
`14`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,6 @@`
`4`	`4`
`5`	`5`	`namespace Meilisearch\Bundle\Exception;`
`6`	`6`
`7`		`-/**`
`8`		`- * Class EntityNotFoundInObjectID.`
`9`		`- */`
`10`	`7`	`final class EntityNotFoundInObjectID extends \LogicException`
`11`	`8`	`{`
`12`	`9`	`}`