Skip to content

Commit 04daa88

Browse files
spawniaactions-user
authored andcommitted
Prettify docs
1 parent 10b5321 commit 04daa88

File tree

1 file changed

+34
-6
lines changed

1 file changed

+34
-6
lines changed

docs/class-reference.md

Lines changed: 34 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ See [related documentation](executing-queries.md).
55

66
@phpstan-import-type FieldResolver from Executor
77

8+
@see \GraphQL\Tests\GraphQLTest
9+
810
### GraphQL\GraphQL Methods
911

1012
```php
@@ -76,11 +78,11 @@ static function executeQuery(
7678
* Same as executeQuery(), but requires PromiseAdapter and always returns a Promise.
7779
* Useful for Async PHP platforms.
7880
*
79-
* @param string|DocumentNode $source
80-
* @param mixed $rootValue
81-
* @param mixed $context
82-
* @param array<string, mixed>|null $variableValues
83-
* @param array<ValidationRule>|null $validationRules
81+
* @param string|DocumentNode $source
82+
* @param mixed $rootValue
83+
* @param mixed $context
84+
* @param array<string, mixed>|null $variableValues
85+
* @param array<ValidationRule>|null $validationRules Defaults to using all available rules
8486
*
8587
* @api
8688
*
@@ -645,6 +647,8 @@ Or using Schema Config instance:
645647
@phpstan-import-type SchemaConfigOptions from SchemaConfig
646648
@phpstan-import-type OperationType from OperationDefinitionNode
647649

650+
@see \GraphQL\Tests\Type\SchemaTest
651+
648652
### GraphQL\Type\Schema Methods
649653

650654
```php
@@ -927,6 +931,8 @@ Those magic functions allow partial parsing:
927931
@method static NodeList<NameNode> directiveLocations(Source|string $source, bool[] $options = [])
928932
@method static NameNode directiveLocation(Source|string $source, bool[] $options = [])
929933

934+
@see \GraphQL\Tests\Language\ParserTest
935+
930936
### GraphQL\Language\Parser Methods
931937

932938
```php
@@ -1010,6 +1016,8 @@ $ast = GraphQL\Language\Parser::parse($query);
10101016
$printed = GraphQL\Language\Printer::doPrint($ast);
10111017
```
10121018

1019+
@see \GraphQL\Tests\Language\PrinterTest
1020+
10131021
### GraphQL\Language\Printer Methods
10141022

10151023
```php
@@ -1109,6 +1117,8 @@ visitor API:
11091117
@phpstan-type NodeVisitor callable(Node): (VisitorOperation|null|false|void)
11101118
@phpstan-type VisitorArray array<string, NodeVisitor>|array<string, array<string, NodeVisitor>>
11111119

1120+
@see \GraphQL\Tests\Language\VisitorTest
1121+
11121122
### GraphQL\Language\Visitor Methods
11131123

11141124
```php
@@ -1258,6 +1268,8 @@ Implements the "Evaluating requests" section of the GraphQL specification.
12581268
@phpstan-type FieldResolver callable(mixed, array<string, mixed>, mixed, ResolveInfo): mixed
12591269
@phpstan-type ImplementationFactory callable(PromiseAdapter, Schema, DocumentNode, mixed, mixed, array<mixed>, ?string, callable): ExecutorImplementation
12601270

1271+
@see \GraphQL\Tests\Executor\ExecutorTest
1272+
12611273
### GraphQL\Executor\Executor Methods
12621274

12631275
```php
@@ -1345,6 +1357,8 @@ extensions?: array<string, mixed>
13451357
@phpstan-type ErrorFormatter callable(\Throwable): SerializableError
13461358
@phpstan-type ErrorsHandler callable(array<Error> $errors, ErrorFormatter $formatter): SerializableErrors
13471359

1360+
@see \GraphQL\Tests\Executor\ExecutionResultTest
1361+
13481362
### GraphQL\Executor\ExecutionResult Props
13491363

13501364
```php
@@ -1548,7 +1562,7 @@ will be created from the provided schema.
15481562
/**
15491563
* Validate a GraphQL query against a schema.
15501564
*
1551-
* @param array<ValidationRule>|null $rules
1565+
* @param array<ValidationRule>|null $rules Defaults to using all available rules
15521566
*
15531567
* @throws \Exception
15541568
*
@@ -1625,6 +1639,8 @@ Also read related docs on [error handling](error-handling.md)
16251639
Class extends standard PHP `\Exception`, so all standard methods of base `\Exception` class
16261640
are available in addition to those listed below.
16271641

1642+
@see \GraphQL\Tests\Error\ErrorTest
1643+
16281644
### GraphQL\Error\Error Methods
16291645

16301646
```php
@@ -1768,6 +1784,8 @@ and provides tools for error debugging.
17681784
@phpstan-import-type SerializableError from ExecutionResult
17691785
@phpstan-import-type ErrorFormatter from ExecutionResult
17701786

1787+
@see \GraphQL\Tests\Error\FormattedErrorTest
1788+
17711789
### GraphQL\Error\FormattedError Methods
17721790

17731791
```php
@@ -1838,6 +1856,8 @@ Or using [ServerConfig](class-reference.md#graphqlserverserverconfig) instance:
18381856

18391857
See [dedicated section in docs](executing-queries.md#using-server) for details.
18401858

1859+
@see \GraphQL\Tests\Server\StandardServerTest
1860+
18411861
### GraphQL\Server\StandardServer Methods
18421862

18431863
```php
@@ -1962,6 +1982,8 @@ Usage example:
19621982
@phpstan-import-type ErrorsHandler from ExecutionResult
19631983
@phpstan-import-type ErrorFormatter from ExecutionResult
19641984

1985+
@see \GraphQL\Tests\Server\ServerConfigTest
1986+
19651987
### GraphQL\Server\ServerConfig Methods
19661988

19671989
```php
@@ -2062,6 +2084,8 @@ function setQueryBatching(bool $enableBatching): self
20622084

20632085
Contains functionality that could be re-used by various server implementations.
20642086

2087+
@see \GraphQL\Tests\Server\HelperTest
2088+
20652089
### GraphQL\Server\Helper Methods
20662090

20672091
```php
@@ -2315,6 +2339,8 @@ assumeValidSDL?: bool
23152339

23162340
Default: false
23172341

2342+
@see \GraphQL\Tests\Utils\BuildSchemaTest
2343+
23182344
### GraphQL\Utils\BuildSchema Methods
23192345

23202346
```php
@@ -2568,6 +2594,8 @@ sortInputFields?: bool,
25682594
sortTypes?: bool,
25692595
}
25702596

2597+
@see \GraphQL\Tests\Utils\SchemaPrinterTest
2598+
25712599
### GraphQL\Utils\SchemaPrinter Methods
25722600

25732601
```php

0 commit comments

Comments
 (0)