Merge #282

282: Remove useless comments r=brunoocasali a=norkunas

# Pull Request

## Related issue
Fixes #<issue_number>

## 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 <[email protected]>

Author: meili-bors[bot]

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;

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

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

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;

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

src/Document/Aggregator.php

@@ -6,9 +6,6 @@
 
 use Meilisearch\Bundle\Model\Aggregator as BaseAggregator;
 
-/**
- * Class Aggregator.
- */
 abstract class Aggregator extends BaseAggregator
 {
 }

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
      */

src/Entity/Aggregator.php

@@ -6,9 +6,6 @@
 
 use Meilisearch\Bundle\Model\Aggregator as BaseAggregator;
 
-/**
- * Class Aggregator.
- */
 abstract class Aggregator extends BaseAggregator
 {
 }

src/Exception/EntityNotFoundInObjectID.php

@@ -4,9 +4,6 @@
 
 namespace Meilisearch\Bundle\Exception;
 
-/**
- * Class EntityNotFoundInObjectID.
- */
 final class EntityNotFoundInObjectID extends \LogicException
 {
 }

src/Exception/InvalidSettingName.php

@@ -4,9 +4,6 @@
 
 namespace Meilisearch\Bundle\Exception;
 
-/**
- * Class InvalidSettingName.
- */
 final class InvalidSettingName extends \LogicException
 {
 }

src/Exception/ObjectIdNotFoundException.php

@@ -4,9 +4,6 @@
 
 namespace Meilisearch\Bundle\Exception;
 
-/**
- * Class ObjectIdNotFoundException.
- */
 final class ObjectIdNotFoundException extends \LogicException
 {
 }

src/Exception/SearchHitsNotFoundException.php

@@ -4,9 +4,6 @@
 
 namespace Meilisearch\Bundle\Exception;
 
-/**
- * Class SearchHitsNotFoundException.
- */
 final class SearchHitsNotFoundException extends \LogicException
 {
 }

src/Exception/TaskException.php

@@ -4,9 +4,6 @@
 
 namespace Meilisearch\Bundle\Exception;
 
-/**
- * Class TaskException.
- */
 final class TaskException extends \LogicException
 {
 }

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';

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)

src/SearchService.php

@@ -6,9 +6,6 @@
 
 use Doctrine\Persistence\ObjectManager;
 
-/**
- * Interface SearchService.
- */
 interface SearchService
 {
     public const RESULT_KEY_HITS = 'hits';

src/Searchable.php

@@ -4,9 +4,6 @@
 
 namespace Meilisearch\Bundle;
 
-/**
- * Class Searchable.
- */
 final class Searchable
 {
     public const NORMALIZATION_FORMAT = 'searchableArray';

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
      */

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;