Skip to content

Commit 1f835bb

Browse files
author
Enda Phelan
committed
fix: use JSDoc style for comments
1 parent 569fca3 commit 1f835bb

11 files changed

+40
-16
lines changed

src/validation/rules/KnownArgumentNames.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ export function KnownArgumentNames(context: ValidationContext): ASTVisitor {
4545
};
4646
}
4747

48-
// @internal
48+
/**
49+
* @internal
50+
*/
4951
export function KnownArgumentNamesOnDirectives(
5052
context: ValidationContext | SDLValidationContext,
5153
): ASTVisitor {

src/validation/rules/ProvidedRequiredArguments.js

+3-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,9 @@ export function ProvidedRequiredArguments(
7171
};
7272
}
7373

74-
// @internal
74+
/**
75+
* @internal
76+
*/
7577
export function ProvidedRequiredArgumentsOnDirectives(
7678
context: ValidationContext | SDLValidationContext,
7779
): ASTVisitor {

src/validation/specifiedRules.js

+5-3
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ import { UniqueDirectivesPerLocation } from './rules/UniqueDirectivesPerLocation
6060
// Spec Section: "Argument Names"
6161
import {
6262
KnownArgumentNames,
63-
KnownArgumentNamesOnDirectives, // @internal
63+
KnownArgumentNamesOnDirectives,
6464
} from './rules/KnownArgumentNames';
6565

6666
// Spec Section: "Argument Uniqueness"
@@ -72,7 +72,7 @@ import { ValuesOfCorrectType } from './rules/ValuesOfCorrectType';
7272
// Spec Section: "Argument Optionality"
7373
import {
7474
ProvidedRequiredArguments,
75-
ProvidedRequiredArgumentsOnDirectives, // @internal
75+
ProvidedRequiredArgumentsOnDirectives,
7676
} from './rules/ProvidedRequiredArguments';
7777

7878
// Spec Section: "All Variable Usages Are Allowed"
@@ -127,7 +127,9 @@ import { UniqueFieldDefinitionNames } from './rules/UniqueFieldDefinitionNames';
127127
import { UniqueDirectiveNames } from './rules/UniqueDirectiveNames';
128128
import { PossibleTypeExtensions } from './rules/PossibleTypeExtensions';
129129

130-
// @internal
130+
/**
131+
* @internal
132+
*/
131133
export const specifiedSDLRules = Object.freeze([
132134
LoneSchemaDefinition,
133135
UniqueOperationTypes,

tstypes/language/blockString.d.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66
*/
77
export function dedentBlockStringValue(rawString: string): string;
88

9-
// @internal
9+
/**
10+
* @internal
11+
*/
1012
export function getBlockStringIndentation(lines: ReadonlyArray<string>): number;
1113

1214
/**

tstypes/language/directiveLocation.d.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
*/
44
export const DirectiveLocation: _DirectiveLocation;
55

6-
// @internal
6+
/**
7+
* @internal
8+
*/
79
type _DirectiveLocation = {
810
// Request Definitions
911
QUERY: 'QUERY';

tstypes/language/kinds.d.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
*/
44
export const Kind: _Kind;
55

6-
// @internal
6+
/**
7+
* @internal
8+
*/
79
type _Kind = {
810
// Name
911
NAME: 'Name';

tstypes/utilities/findBreakingChanges.d.ts

+6-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ import { DirectiveLocationEnum } from '../language/directiveLocation';
44

55
export const BreakingChangeType: _BreakingChangeType;
66

7-
// @internal
7+
/**
8+
* @internal
9+
*/
810
type _BreakingChangeType = {
911
TYPE_REMOVED: 'TYPE_REMOVED';
1012
TYPE_CHANGED_KIND: 'TYPE_CHANGED_KIND';
@@ -25,7 +27,9 @@ type _BreakingChangeType = {
2527

2628
export const DangerousChangeType: _DangerousChangeType;
2729

28-
// @internal
30+
/**
31+
* @internal
32+
*/
2933
type _DangerousChangeType = {
3034
VALUE_ADDED_TO_ENUM: 'VALUE_ADDED_TO_ENUM';
3135
TYPE_ADDED_TO_UNION: 'TYPE_ADDED_TO_UNION';

tstypes/validation/rules/KnownArgumentNames.d.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ import { ASTVisitor } from '../../language/visitor';
99
*/
1010
export function KnownArgumentNames(context: ValidationContext): ASTVisitor;
1111

12-
// @internal
12+
/**
13+
* @internal
14+
*/
1315
export function KnownArgumentNamesOnDirectives(
1416
context: ValidationContext | SDLValidationContext,
1517
): ASTVisitor;

tstypes/validation/rules/ProvidedRequiredArguments.d.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ export function ProvidedRequiredArguments(
1111
context: ValidationContext,
1212
): ASTVisitor;
1313

14-
// @internal
14+
/**
15+
* @internal
16+
*/
1517
export function ProvidedRequiredArgumentsOnDirectives(
1618
context: ValidationContext | SDLValidationContext,
1719
): ASTVisitor;

tstypes/validation/specifiedRules.d.ts

+5-3
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ import { UniqueDirectivesPerLocation } from './rules/UniqueDirectivesPerLocation
6060
// Spec Section: "Argument Names"
6161
import {
6262
KnownArgumentNames,
63-
KnownArgumentNamesOnDirectives, // @internal
63+
KnownArgumentNamesOnDirectives,
6464
} from './rules/KnownArgumentNames';
6565

6666
// Spec Section: "Argument Uniqueness"
@@ -72,7 +72,7 @@ import { ValuesOfCorrectType } from './rules/ValuesOfCorrectType';
7272
// Spec Section: "Argument Optionality"
7373
import {
7474
ProvidedRequiredArguments,
75-
ProvidedRequiredArgumentsOnDirectives, // @internal
75+
ProvidedRequiredArgumentsOnDirectives,
7676
} from './rules/ProvidedRequiredArguments';
7777

7878
// Spec Section: "All Variable Usages Are Allowed"
@@ -94,5 +94,7 @@ export const specifiedRules: ReadonlyArray<ValidationRule>;
9494

9595
import { LoneSchemaDefinition } from './rules/LoneSchemaDefinition';
9696

97-
// @internal
97+
/**
98+
* @internal
99+
*/
98100
export const specifiedSDLRules: ReadonlyArray<SDLValidationRule>;

tstypes/validation/validate.d.ts

+3-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,9 @@ export function validate(
2929
options?: { maxErrors?: number },
3030
): ReadonlyArray<GraphQLError>;
3131

32-
// @internal
32+
/**
33+
* @internal
34+
*/
3335
export function validateSDL(
3436
documentAST: DocumentNode,
3537
schemaToExtend?: Maybe<GraphQLSchema>,

0 commit comments

Comments
 (0)