Remove useless Class comments

williamdes · williamdes · commit 50cdaae6bc5f · 2020-10-08T12:16:33.000+02:00
diff --git a/src/Message/Exceptions/InvalidOptionsException.php b/src/Message/Exceptions/InvalidOptionsException.php
@@ -4,9 +4,6 @@
 
 use Exception;
 
-/**
- * Class InvalidOptionsException.
- */
 class InvalidOptionsException extends Exception
 {
 }
diff --git a/src/Message/Exceptions/NoTopicProvidedException.php b/src/Message/Exceptions/NoTopicProvidedException.php
@@ -4,9 +4,6 @@
 
 use Exception;
 
-/**
- * Class NoTopicProvidedException.
- */
 class NoTopicProvidedException extends Exception
 {
 }
diff --git a/src/Message/Options.php b/src/Message/Options.php
@@ -4,9 +4,6 @@
 
 use Illuminate\Contracts\Support\Arrayable;
 
-/**
- * Class Options.
- */
 class Options implements Arrayable
 {
     /**
diff --git a/src/Message/OptionsBuilder.php b/src/Message/OptionsBuilder.php
@@ -8,8 +8,6 @@
 /**
  * Builder for creation of options used by FCM.
  *
- * Class OptionsBuilder
- *
  * @link http://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream-http-messages-json
  */
 class OptionsBuilder
@@ -329,9 +327,6 @@ public function build()
     }
 }
 
-/**
- * Class OptionsPriorities.
- */
 final class OptionsPriorities
 {
     /**
diff --git a/src/Message/PayloadData.php b/src/Message/PayloadData.php
@@ -4,9 +4,6 @@
 
 use Illuminate\Contracts\Support\Arrayable;
 
-/**
- * Class PayloadData.
- */
 class PayloadData implements Arrayable
 {
     /**
diff --git a/src/Message/PayloadDataBuilder.php b/src/Message/PayloadDataBuilder.php
@@ -3,8 +3,6 @@
 namespace LaravelFCM\Message;
 
 /**
- * Class PayloadDataBuilder.
- *
  * Official google documentation :
  *
  * @link http://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream-http-messages-json
diff --git a/src/Message/PayloadNotification.php b/src/Message/PayloadNotification.php
@@ -4,9 +4,6 @@
 
 use Illuminate\Contracts\Support\Arrayable;
 
-/**
- * Class PayloadNotification.
- */
 class PayloadNotification implements Arrayable
 {
     /**
diff --git a/src/Message/PayloadNotificationBuilder.php b/src/Message/PayloadNotificationBuilder.php
@@ -3,7 +3,6 @@
 namespace LaravelFCM\Message;
 
 /**
- * Class PayloadNotificationBuilder.
  *
  * Official google documentation :
  *
diff --git a/src/Message/Topics.php b/src/Message/Topics.php
@@ -6,8 +6,6 @@
 use LaravelFCM\Message\Exceptions\NoTopicProvidedException;
 
 /**
- * Class Topics.
- *
  * Create topic or a topic condition
  */
 class Topics
diff --git a/src/Request/BaseRequest.php b/src/Request/BaseRequest.php
@@ -2,9 +2,6 @@
 
 namespace LaravelFCM\Request;
 
-/**
- * Class BaseRequest.
- */
 abstract class BaseRequest
 {
     /**
diff --git a/src/Request/GroupRequest.php b/src/Request/GroupRequest.php
@@ -2,9 +2,6 @@
 
 namespace LaravelFCM\Request;
 
-/**
- * Class GroupRequest.
- */
 class GroupRequest extends BaseRequest
 {
     /**
diff --git a/src/Request/Request.php b/src/Request/Request.php
@@ -7,9 +7,6 @@
 use LaravelFCM\Message\PayloadData;
 use LaravelFCM\Message\PayloadNotification;
 
-/**
- * Class Request.
- */
 class Request extends BaseRequest
 {
     /**
diff --git a/src/Request/TopicRequest.php b/src/Request/TopicRequest.php
@@ -2,9 +2,6 @@
 
 namespace LaravelFCM\Request;
 
-/**
- * Class TopicRequest.
- */
 class TopicRequest extends BaseRequest
 {
     /**
diff --git a/src/Response/BaseResponse.php b/src/Response/BaseResponse.php
@@ -8,9 +8,6 @@
 use LaravelFCM\Response\Exceptions\UnauthorizedRequestException;
 use Monolog\Logger;
 
-/**
- * Class BaseResponse.
- */
 abstract class BaseResponse
 {
     const SUCCESS = 'success';
diff --git a/src/Response/DownstreamResponse.php b/src/Response/DownstreamResponse.php
@@ -5,9 +5,6 @@
 use Psr\Http\Message\ResponseInterface;
 use Monolog\Logger;
 
-/**
- * Class DownstreamResponse.
- */
 class DownstreamResponse extends BaseResponse implements DownstreamResponseContract
 {
     const MULTICAST_ID = 'multicast_id';
diff --git a/src/Response/Exceptions/InvalidRequestException.php b/src/Response/Exceptions/InvalidRequestException.php
@@ -5,9 +5,6 @@
 use Exception;
 use Psr\Http\Message\ResponseInterface;
 
-/**
- * Class InvalidRequestException.
- */
 class InvalidRequestException extends Exception
 {
     /**
diff --git a/src/Response/Exceptions/ServerResponseException.php b/src/Response/Exceptions/ServerResponseException.php
@@ -5,9 +5,6 @@
 use Exception;
 use Psr\Http\Message\ResponseInterface;
 
-/**
- * Class ServerResponseException.
- */
 class ServerResponseException extends Exception
 {
     /**
diff --git a/src/Response/Exceptions/UnauthorizedRequestException.php b/src/Response/Exceptions/UnauthorizedRequestException.php
@@ -5,9 +5,6 @@
 use Exception;
 use Psr\Http\Message\ResponseInterface;
 
-/**
- * Class UnauthorizedRequestException.
- */
 class UnauthorizedRequestException extends Exception
 {
     /**
diff --git a/src/Response/GroupResponse.php b/src/Response/GroupResponse.php
@@ -5,9 +5,6 @@
 use Psr\Http\Message\ResponseInterface;
 use Monolog\Logger;
 
-/**
- * Class GroupResponse.
- */
 class GroupResponse extends BaseResponse implements GroupResponseContract
 {
     const FAILED_REGISTRATION_IDS = 'failed_registration_ids';
diff --git a/src/Response/TopicResponse.php b/src/Response/TopicResponse.php
@@ -6,9 +6,6 @@
 use Psr\Http\Message\ResponseInterface;
 use Monolog\Logger;
 
-/**
- * Class TopicResponse.
- */
 class TopicResponse extends BaseResponse implements TopicResponseContract
 {
     const LIMIT_RATE_TOPICS_EXCEEDED = 'TopicsMessageRateExceeded';
diff --git a/src/Sender/FCMGroup.php b/src/Sender/FCMGroup.php
@@ -5,9 +5,6 @@
 use LaravelFCM\Request\GroupRequest;
 use Psr\Http\Message\ResponseInterface;
 
-/**
- * Class FCMGroup.
- */
 class FCMGroup extends HTTPSender
 {
     const CREATE = 'create';
diff --git a/src/Sender/FCMSender.php b/src/Sender/FCMSender.php
@@ -12,9 +12,6 @@
 use LaravelFCM\Response\DownstreamResponse;
 use LaravelFCM\Message\PayloadNotification;
 
-/**
- * Class FCMSender.
- */
 class FCMSender extends HTTPSender
 {
     const MAX_TOKEN_PER_REQUEST = 1000;
diff --git a/src/Sender/FCMTopic.php b/src/Sender/FCMTopic.php
@@ -5,9 +5,6 @@
 use LaravelFCM\Request\TopicRequest;
 use Psr\Http\Message\ResponseInterface;
 
-/**
- * Class FCMGroup.
- */
 class FCMTopic extends HTTPSender {
 
     private $add_subscription_url = 'https://iid.googleapis.com/iid/v1:batchAdd';
diff --git a/src/Sender/HTTPSender.php b/src/Sender/HTTPSender.php
@@ -5,9 +5,6 @@
 use GuzzleHttp\ClientInterface;
 use Monolog\Logger;
 
-/**
- * Class BaseSender.
- */
 abstract class HTTPSender
 {
     /**
diff --git a/tests/mocks/MockDownstreamResponse.php b/tests/mocks/MockDownstreamResponse.php
@@ -5,9 +5,6 @@
 use LaravelFCM\Response\DownstreamResponse;
 use LaravelFCM\Response\DownstreamResponseContract;
 
-/**
- * Class MockDownstreamResponse **Only use it for testing**.
- */
 class MockDownstreamResponse implements DownstreamResponseContract
 {
     /**
diff --git a/tests/mocks/MockGroupResponse.php b/tests/mocks/MockGroupResponse.php
@@ -4,9 +4,6 @@
 
 use LaravelFCM\Response\GroupResponseContract;
 
-/**
- * Class MockGroupResponse **Only use it for testing**.
- */
 class MockGroupResponse implements GroupResponseContract
 {
     /**
diff --git a/tests/mocks/MockTopicResponse.php b/tests/mocks/MockTopicResponse.php
@@ -4,9 +4,6 @@
 
 use LaravelFCM\Response\TopicResponseContract;
 
-/**
- * Class MockTopicResponse **Only use it for testing**.
- */
 class MockTopicResponse implements TopicResponseContract
 {
     /**

Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,6 @@`
`4`	`4`
`5`	`5`	`use Exception;`
`6`	`6`
`7`		`-/**`
`8`		`- * Class InvalidOptionsException.`
`9`		`- */`
`10`	`7`	`class InvalidOptionsException extends Exception`
`11`	`8`	`{`
`12`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,6 @@`
`4`	`4`
`5`	`5`	`use Illuminate\Contracts\Support\Arrayable;`
`6`	`6`
`7`		`-/**`
`8`		`- * Class Options.`
`9`		`- */`
`10`	`7`	`class Options implements Arrayable`
`11`	`8`	`{`
`12`	`9`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -8,8 +8,6 @@`
`8`	`8`	`/**`
`9`	`9`	`* Builder for creation of options used by FCM.`
`10`	`10`	`*`
`11`		`- * Class OptionsBuilder`
`12`		`- *`
`13`	`11`	`* @link http://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream-http-messages-json`
`14`	`12`	`*/`
`15`	`13`	`class OptionsBuilder`
`@@ -329,9 +327,6 @@ public function build()`
`329`	`327`	`}`
`330`	`328`	`}`
`331`	`329`
`332`		`-/**`
`333`		`- * Class OptionsPriorities.`
`334`		`- */`
`335`	`330`	`final class OptionsPriorities`
`336`	`331`	`{`
`337`	`332`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,6 @@`
`3`	`3`	`namespace LaravelFCM\Message;`
`4`	`4`
`5`	`5`	`/**`
`6`		`- * Class PayloadDataBuilder.`
`7`		`- *`
`8`	`6`	`* Official google documentation :`
`9`	`7`	`*`
`10`	`8`	`* @link http://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream-http-messages-json`
Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,6 @@`
`3`	`3`	`namespace LaravelFCM\Message;`
`4`	`4`
`5`	`5`	`/**`
`6`		`- * Class PayloadNotificationBuilder.`
`7`	`6`	`*`
`8`	`7`	`* Official google documentation :`
`9`	`8`	`*`
Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,6 @@`
`2`	`2`
`3`	`3`	`namespace LaravelFCM\Request;`
`4`	`4`
`5`		`-/**`
`6`		`- * Class BaseRequest.`
`7`		`- */`
`8`	`5`	`abstract class BaseRequest`
`9`	`6`	`{`
`10`	`7`	`/**`