Skip to content

Commit df0edf6

Browse files
bbakermanbbakerman
authored
Javadoc warnings cleanup (graphql-java#1272)
* Added @OverRide as part of errorprone code health check * Revert "Added @OverRide as part of errorprone code health check" This reverts commit 38dfab1 * On the command line, there are JavaDoc warnings. This cleans them up!
1 parent 232373f commit df0edf6

34 files changed

Lines changed: 151 additions & 72 deletions

‎src/main/java/graphql/language/Argument.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ protected Argument(String name, Value value, SourceLocation sourceLocation, List
2626
/**
2727
* alternative to using a Builder for convenience
2828
*
29-
* @param name
30-
* @param value
29+
* @param name of the argument
30+
* @param value of the argument
3131
*/
3232
public Argument(String name, Value value) {
3333
this(name, value, null, new ArrayList<>());

‎src/main/java/graphql/language/ArrayValue.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ protected ArrayValue(List<Value> values, SourceLocation sourceLocation, List<Com
2424
/**
2525
* alternative to using a Builder for convenience
2626
*
27-
* @param values
27+
* @param values of the array
2828
*/
2929
public ArrayValue(List<Value> values) {
3030
super(null, new ArrayList<>());

‎src/main/java/graphql/language/BooleanValue.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ protected BooleanValue(boolean value, SourceLocation sourceLocation, List<Commen
2424
/**
2525
* alternative to using a Builder for convenience
2626
*
27-
* @param value
27+
* @param value of the Boolean
2828
*/
2929
public BooleanValue(boolean value) {
3030
super(null, new ArrayList<>());

‎src/main/java/graphql/language/Directive.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ protected Directive(String name, List<Argument> arguments, SourceLocation source
2727

2828
/**
2929
* alternative to using a Builder for convenience
30+
*
31+
* @param name of the directive
32+
* @param arguments of the directive
3033
*/
3134
public Directive(String name, List<Argument> arguments) {
3235
this(name, arguments, null, new ArrayList<>());
@@ -35,6 +38,8 @@ public Directive(String name, List<Argument> arguments) {
3538

3639
/**
3740
* alternative to using a Builder for convenience
41+
*
42+
* @param name of the directive
3843
*/
3944
public Directive(String name) {
4045
this(name, new ArrayList<>(), null, new ArrayList<>());

‎src/main/java/graphql/language/DirectiveDefinition.java‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ public class DirectiveDefinition extends AbstractNode<DirectiveDefinition> imple
1919

2020
@Internal
2121
protected DirectiveDefinition(String name,
22-
List<InputValueDefinition> inputValueDefinitions,
23-
List<DirectiveLocation> directiveLocations,
24-
SourceLocation sourceLocation,
25-
List<Comment> comments
22+
List<InputValueDefinition> inputValueDefinitions,
23+
List<DirectiveLocation> directiveLocations,
24+
SourceLocation sourceLocation,
25+
List<Comment> comments
2626
) {
2727
super(sourceLocation, comments);
2828
this.name = name;
@@ -32,6 +32,8 @@ protected DirectiveDefinition(String name,
3232

3333
/**
3434
* alternative to using a Builder for convenience
35+
*
36+
* @param name of the directive definition
3537
*/
3638
public DirectiveDefinition(String name) {
3739
this(name, new ArrayList<>(), new ArrayList<>(), null, new ArrayList<>());

‎src/main/java/graphql/language/DirectiveLocation.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@ protected DirectiveLocation(String name, SourceLocation sourceLocation, List<Com
3030

3131
/**
3232
* alternative to using a Builder for convenience
33+
*
34+
* @param name of the directive location
3335
*/
3436
public DirectiveLocation(String name) {
3537
this(name, null, new ArrayList<>());

‎src/main/java/graphql/language/Document.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ protected Document(List<Definition> definitions, SourceLocation sourceLocation,
2323

2424
/**
2525
* alternative to using a Builder for convenience
26+
*
27+
* @param definitions the definitions that make up this document
2628
*/
2729
public Document(List<Definition> definitions) {
2830
this(definitions, null, new ArrayList<>());

‎src/main/java/graphql/language/EnumTypeDefinition.java‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ public class EnumTypeDefinition extends AbstractNode<EnumTypeDefinition> impleme
1818

1919
@Internal
2020
protected EnumTypeDefinition(String name,
21-
List<EnumValueDefinition> enumValueDefinitions,
22-
List<Directive> directives,
23-
Description description,
24-
SourceLocation sourceLocation,
25-
List<Comment> comments) {
21+
List<EnumValueDefinition> enumValueDefinitions,
22+
List<Directive> directives,
23+
Description description,
24+
SourceLocation sourceLocation,
25+
List<Comment> comments) {
2626
super(sourceLocation, comments);
2727
this.name = name;
2828
this.description = description;
@@ -32,6 +32,8 @@ protected EnumTypeDefinition(String name,
3232

3333
/**
3434
* alternative to using a Builder for convenience
35+
*
36+
* @param name of the enum
3537
*/
3638
public EnumTypeDefinition(String name) {
3739
this(name, new ArrayList<>(), new ArrayList<>(), null, null, new ArrayList<>());

‎src/main/java/graphql/language/EnumValue.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ protected EnumValue(String name, SourceLocation sourceLocation, List<Comment> co
2525
/**
2626
* alternative to using a Builder for convenience
2727
*
28-
* @param name
28+
* @param name of the enum value
2929
*/
3030
public EnumValue(String name) {
3131
super(null, new ArrayList<>());

‎src/main/java/graphql/language/EnumValueDefinition.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,18 @@ protected EnumValueDefinition(String name,
3131

3232
/**
3333
* alternative to using a Builder for convenience
34+
*
35+
* @param name of the enum value
3436
*/
3537
public EnumValueDefinition(String name) {
3638
this(name, new ArrayList<>(), null, null, new ArrayList<>());
3739
}
3840

3941
/**
4042
* alternative to using a Builder for convenience
43+
*
44+
* @param name of the enum value
45+
* @param directives the directives on the enum value
4146
*/
4247
public EnumValueDefinition(String name, List<Directive> directives) {
4348
this(name, directives, null, null, new ArrayList<>());

0 commit comments

Comments
 (0)