Skip to content

Commit 10b5321

Browse files
committed
Add @see annotations that link to tests
1 parent 9052012 commit 10b5321

24 files changed

+49
-0
lines changed

src/Error/Error.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
*
2020
* Class extends standard PHP `\Exception`, so all standard methods of base `\Exception` class
2121
* are available in addition to those listed below.
22+
*
23+
* @see \GraphQL\Tests\Error\ErrorTest
2224
*/
2325
class Error extends \Exception implements \JsonSerializable, ClientAware, ProvidesExtensions
2426
{

src/Error/FormattedError.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717
*
1818
* @phpstan-import-type SerializableError from ExecutionResult
1919
* @phpstan-import-type ErrorFormatter from ExecutionResult
20+
*
21+
* @see \GraphQL\Tests\Error\FormattedErrorTest
2022
*/
2123
class FormattedError
2224
{

src/Executor/ExecutionResult.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
* }
2929
* @phpstan-type ErrorFormatter callable(\Throwable): SerializableError
3030
* @phpstan-type ErrorsHandler callable(array<Error> $errors, ErrorFormatter $formatter): SerializableErrors
31+
*
32+
* @see \GraphQL\Tests\Executor\ExecutionResultTest
3133
*/
3234
class ExecutionResult implements \JsonSerializable
3335
{

src/Executor/Executor.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
*
1717
* @phpstan-type FieldResolver callable(mixed, array<string, mixed>, mixed, ResolveInfo): mixed
1818
* @phpstan-type ImplementationFactory callable(PromiseAdapter, Schema, DocumentNode, mixed, mixed, array<mixed>, ?string, callable): ExecutorImplementation
19+
*
20+
* @see \GraphQL\Tests\Executor\ExecutorTest
1921
*/
2022
class Executor
2123
{

src/Executor/Values.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@
4545
* @see ArgumentNode - force IDE import
4646
*
4747
* @phpstan-import-type ArgumentNodeValue from ArgumentNode
48+
*
49+
* @see \GraphQL\Tests\Executor\ValuesTest
4850
*/
4951
class Values
5052
{

src/GraphQL.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@
2525
* See [related documentation](executing-queries.md).
2626
*
2727
* @phpstan-import-type FieldResolver from Executor
28+
*
29+
* @see \GraphQL\Tests\GraphQLTest
2830
*/
2931
class GraphQL
3032
{

src/Language/AST/Node.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
* | DirectiveNode
2929
* | ListTypeNode
3030
* | NonNullTypeNode.
31+
*
32+
* @see \GraphQL\Tests\Language\AST\NodeTest
3133
*/
3234
abstract class Node implements \JsonSerializable
3335
{

src/Language/BlockString.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
use GraphQL\Utils\Utils;
66

7+
/**
8+
* @see \GraphQL\Tests\Language\BlockStringTest
9+
*/
710
class BlockString
811
{
912
/**

src/Language/Lexer.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
* Algorithm is O(N) both on memory and time.
1616
*
1717
* @phpstan-import-type ParserOptions from Parser
18+
*
19+
* @see \GraphQL\Tests\Language\LexerTest
1820
*/
1921
class Lexer
2022
{

src/Language/Parser.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,8 @@
169169
* @method static DirectiveDefinitionNode directiveDefinition(Source|string $source, bool[] $options = [])
170170
* @method static NodeList<NameNode> directiveLocations(Source|string $source, bool[] $options = [])
171171
* @method static NameNode directiveLocation(Source|string $source, bool[] $options = [])
172+
*
173+
* @see \GraphQL\Tests\Language\ParserTest
172174
*/
173175
class Parser
174176
{

0 commit comments

Comments
 (0)