Skip to content

Commit 33208d4

Browse files
lyrixxlyrixx
committed
Drop useless phpdoc, already covered by PHP
1 parent fe5ea30 commit 33208d4

5 files changed

+2
-86
lines changed

‎src/LoggerAwareInterface.php

-4
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,6 @@ interface LoggerAwareInterface
99
{
1010
/**
1111
* Sets a logger instance on the object.
12-
*
13-
* @param LoggerInterface $logger
14-
*
15-
* @return void
1612
*/
1713
public function setLogger(LoggerInterface $logger): void;
1814
}

‎src/LoggerAwareTrait.php

-4
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,11 @@ trait LoggerAwareTrait
99
{
1010
/**
1111
* The logger instance.
12-
*
13-
* @var LoggerInterface|null
1412
*/
1513
protected ?LoggerInterface $logger = null;
1614

1715
/**
1816
* Sets a logger.
19-
*
20-
* @param LoggerInterface $logger
2117
*/
2218
public function setLogger(LoggerInterface $logger): void
2319
{

‎src/LoggerInterface.php

-28
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,7 @@ interface LoggerInterface
2222
/**
2323
* System is unusable.
2424
*
25-
* @param string|\Stringable $message
2625
* @param mixed[] $context
27-
*
28-
* @return void
2926
*/
3027
public function emergency(string|\Stringable $message, array $context = []): void;
3128

@@ -35,10 +32,7 @@ public function emergency(string|\Stringable $message, array $context = []): voi
3532
* Example: Entire website down, database unavailable, etc. This should
3633
* trigger the SMS alerts and wake you up.
3734
*
38-
* @param string|\Stringable $message
3935
* @param mixed[] $context
40-
*
41-
* @return void
4236
*/
4337
public function alert(string|\Stringable $message, array $context = []): void;
4438

@@ -47,21 +41,15 @@ public function alert(string|\Stringable $message, array $context = []): void;
4741
*
4842
* Example: Application component unavailable, unexpected exception.
4943
*
50-
* @param string|\Stringable $message
5144
* @param mixed[] $context
52-
*
53-
* @return void
5445
*/
5546
public function critical(string|\Stringable $message, array $context = []): void;
5647

5748
/**
5849
* Runtime errors that do not require immediate action but should typically
5950
* be logged and monitored.
6051
*
61-
* @param string|\Stringable $message
6252
* @param mixed[] $context
63-
*
64-
* @return void
6553
*/
6654
public function error(string|\Stringable $message, array $context = []): void;
6755

@@ -71,20 +59,14 @@ public function error(string|\Stringable $message, array $context = []): void;
7159
* Example: Use of deprecated APIs, poor use of an API, undesirable things
7260
* that are not necessarily wrong.
7361
*
74-
* @param string|\Stringable $message
7562
* @param mixed[] $context
76-
*
77-
* @return void
7863
*/
7964
public function warning(string|\Stringable $message, array $context = []): void;
8065

8166
/**
8267
* Normal but significant events.
8368
*
84-
* @param string|\Stringable $message
8569
* @param mixed[] $context
86-
*
87-
* @return void
8870
*/
8971
public function notice(string|\Stringable $message, array $context = []): void;
9072

@@ -93,32 +75,22 @@ public function notice(string|\Stringable $message, array $context = []): void;
9375
*
9476
* Example: User logs in, SQL logs.
9577
*
96-
* @param string|\Stringable $message
9778
* @param mixed[] $context
98-
*
99-
* @return void
10079
*/
10180
public function info(string|\Stringable $message, array $context = []): void;
10281

10382
/**
10483
* Detailed debug information.
10584
*
106-
* @param string|\Stringable $message
10785
* @param mixed[] $context
108-
*
109-
* @return void
11086
*/
11187
public function debug(string|\Stringable $message, array $context = []): void;
11288

11389
/**
11490
* Logs with an arbitrary level.
11591
*
116-
* @param mixed $level
117-
* @param string|\Stringable $message
11892
* @param mixed[] $context
11993
*
120-
* @return void
121-
*
12294
* @throws \Psr\Log\InvalidArgumentException
12395
*/
12496
public function log($level, string|\Stringable $message, array $context = []): void;

‎src/LoggerTrait.php

+1-45
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,6 @@ trait LoggerTrait
1414
{
1515
/**
1616
* System is unusable.
17-
*
18-
* @param string|\Stringable $message
19-
* @param array $context
20-
*
21-
* @return void
2217
*/
2318
public function emergency(string|\Stringable $message, array $context = []): void
2419
{
@@ -30,11 +25,6 @@ public function emergency(string|\Stringable $message, array $context = []): voi
3025
*
3126
* Example: Entire website down, database unavailable, etc. This should
3227
* trigger the SMS alerts and wake you up.
33-
*
34-
* @param string|\Stringable $message
35-
* @param array $context
36-
*
37-
* @return void
3828
*/
3929
public function alert(string|\Stringable $message, array $context = []): void
4030
{
@@ -45,11 +35,6 @@ public function alert(string|\Stringable $message, array $context = []): void
4535
* Critical conditions.
4636
*
4737
* Example: Application component unavailable, unexpected exception.
48-
*
49-
* @param string|\Stringable $message
50-
* @param array $context
51-
*
52-
* @return void
5338
*/
5439
public function critical(string|\Stringable $message, array $context = []): void
5540
{
@@ -59,11 +44,6 @@ public function critical(string|\Stringable $message, array $context = []): void
5944
/**
6045
* Runtime errors that do not require immediate action but should typically
6146
* be logged and monitored.
62-
*
63-
* @param string|\Stringable $message
64-
* @param array $context
65-
*
66-
* @return void
6747
*/
6848
public function error(string|\Stringable $message, array $context = []): void
6949
{
@@ -75,11 +55,6 @@ public function error(string|\Stringable $message, array $context = []): void
7555
*
7656
* Example: Use of deprecated APIs, poor use of an API, undesirable things
7757
* that are not necessarily wrong.
78-
*
79-
* @param string|\Stringable $message
80-
* @param array $context
81-
*
82-
* @return void
8358
*/
8459
public function warning(string|\Stringable $message, array $context = []): void
8560
{
@@ -88,11 +63,6 @@ public function warning(string|\Stringable $message, array $context = []): void
8863

8964
/**
9065
* Normal but significant events.
91-
*
92-
* @param string|\Stringable $message
93-
* @param array $context
94-
*
95-
* @return void
9666
*/
9767
public function notice(string|\Stringable $message, array $context = []): void
9868
{
@@ -103,11 +73,6 @@ public function notice(string|\Stringable $message, array $context = []): void
10373
* Interesting events.
10474
*
10575
* Example: User logs in, SQL logs.
106-
*
107-
* @param string|\Stringable $message
108-
* @param array $context
109-
*
110-
* @return void
11176
*/
11277
public function info(string|\Stringable $message, array $context = []): void
11378
{
@@ -116,11 +81,6 @@ public function info(string|\Stringable $message, array $context = []): void
11681

11782
/**
11883
* Detailed debug information.
119-
*
120-
* @param string|\Stringable $message
121-
* @param array $context
122-
*
123-
* @return void
12484
*/
12585
public function debug(string|\Stringable $message, array $context = []): void
12686
{
@@ -130,11 +90,7 @@ public function debug(string|\Stringable $message, array $context = []): void
13090
/**
13191
* Logs with an arbitrary level.
13292
*
133-
* @param mixed $level
134-
* @param string|\Stringable $message
135-
* @param array $context
136-
*
137-
* @return void
93+
* @param mixed $level
13894
*
13995
* @throws \Psr\Log\InvalidArgumentException
14096
*/

‎src/NullLogger.php

+1-5
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,7 @@ class NullLogger extends AbstractLogger
1515
/**
1616
* Logs with an arbitrary level.
1717
*
18-
* @param mixed $level
19-
* @param string|\Stringable $message
20-
* @param array $context
21-
*
22-
* @return void
18+
* @param mixed[] $context
2319
*
2420
* @throws \Psr\Log\InvalidArgumentException
2521
*/

0 commit comments

Comments
 (0)