Skip to content

Commit 41cce50

Browse files
committed
doc: Replace tt tags in javadoc with {@code}.
1 parent 343b4d5 commit 41cce50

File tree

6 files changed

+28
-28
lines changed

6 files changed

+28
-28
lines changed

src/main/java/cz/jirutka/rsql/parser/RSQLParser.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ public RSQLParser() {
8787
* Creates a new instance of {@code RSQLParser} that supports only the specified comparison
8888
* operators.
8989
*
90-
* @param operators A set of supported comparison operators. Must not be <tt>null</tt> or empty.
90+
* @param operators A set of supported comparison operators. Must not be {@code null} or empty.
9191
*/
9292
public RSQLParser(Set<ComparisonOperator> operators) {
9393
this(new NodesFactory(operators));
@@ -96,7 +96,7 @@ public RSQLParser(Set<ComparisonOperator> operators) {
9696
/**
9797
* Creates a new instance of {@code RSQLParser} with given node factory.
9898
*
99-
* @param nodesFactory A node factory to use. Must not be <tt>null</tt>.
99+
* @param nodesFactory A node factory to use. Must not be {@code null}.
100100
*/
101101
public RSQLParser(NodesFactory nodesFactory) {
102102
if (nodesFactory == null) {
@@ -114,7 +114,7 @@ public RSQLParser(NodesFactory nodesFactory) {
114114
*
115115
* @throws RSQLParserException If some exception occurred during parsing, i.e. the
116116
* {@code query} is syntactically invalid.
117-
* @throws IllegalArgumentException If the {@code query} is <tt>null</tt>.
117+
* @throws IllegalArgumentException If the {@code query} is {@code null}.
118118
*/
119119
public Node parse(String query) throws RSQLParserException {
120120
if (query == null) {

src/main/java/cz/jirutka/rsql/parser/ast/AbstractNode.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public abstract class AbstractNode implements Node {
2828
/**
2929
* Accepts the visitor, calls its visit() method and returns the result.
3030
* This method just calls {@link #accept(RSQLVisitor, Object)} with
31-
* <tt>null</tt> as the second argument.
31+
* {@code null} as the second argument.
3232
*/
3333
public <R, A> R accept(RSQLVisitor<R, A> visitor) {
3434
return accept(visitor, null);

src/main/java/cz/jirutka/rsql/parser/ast/ComparisonNode.java

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232

3333
/**
3434
* This node represents a comparison with operator, selector and arguments,
35-
* e.g. <tt>name=in=(Jimmy,James)</tt>.
35+
* e.g. {@code name=in=(Jimmy,James)}.
3636
*/
3737
@Immutable
3838
public final class ComparisonNode extends AbstractNode {
@@ -44,9 +44,9 @@ public final class ComparisonNode extends AbstractNode {
4444
private final List<String> arguments;
4545

4646
/**
47-
* @param operator Must not be <tt>null</tt>.
48-
* @param selector Must not be <tt>null</tt> or blank.
49-
* @param arguments Must not be <tt>null</tt> or empty. If the operator is not
47+
* @param operator Must not be {@code null}.
48+
* @param selector Must not be {@code null} or blank.
49+
* @param arguments Must not be {@code null} or empty. If the operator is not
5050
* {@link ComparisonOperator#isMultiValue() multiValue}, then it must contain exactly
5151
* one argument.
5252
* @throws IllegalArgumentException If one of the conditions specified above it not met.
@@ -78,7 +78,7 @@ public ComparisonOperator getOperator() {
7878
/**
7979
* Returns a copy of this node with the specified operator.
8080
*
81-
* @param newOperator Must not be <tt>null</tt>.
81+
* @param newOperator Must not be {@code null}.
8282
* @return a copy of this node with the specified operator.
8383
*/
8484
public ComparisonNode withOperator(ComparisonOperator newOperator) {
@@ -92,7 +92,7 @@ public String getSelector() {
9292
/**
9393
* Returns a copy of this node with the specified selector.
9494
*
95-
* @param newSelector Must not be <tt>null</tt> or blank.
95+
* @param newSelector Must not be {@code null} or blank.
9696
* @return a copy of this node with the specified selector.
9797
*/
9898
public ComparisonNode withSelector(String newSelector) {
@@ -115,7 +115,7 @@ public List<String> getArguments() {
115115
/**
116116
* Returns a copy of this node with the specified arguments.
117117
*
118-
* @param newArguments Must not be <tt>null</tt> or empty. If the operator is not
118+
* @param newArguments Must not be {@code null} or empty. If the operator is not
119119
* {@link ComparisonOperator#isMultiValue() multiValue}, then it must contain exactly
120120
* one argument.
121121
* @return a copy of this node with the specified arguments.

src/main/java/cz/jirutka/rsql/parser/ast/ComparisonOperator.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,12 @@ public final class ComparisonOperator {
4040
private final Arity arity;
4141

4242
/**
43-
* @param symbols Textual representation of this operator (e.g. <tt>=gt=</tt>); the first item
43+
* @param symbols Textual representation of this operator (e.g. {@code =gt=}); the first item
4444
* is primary representation, any others are alternatives. Must match
4545
* {@literal =[a-zA-Z]*=|[><]=?|!=}.
4646
* @param multiValue Whether this operator may be used with multiple arguments. This is then
4747
* validated in {@link NodesFactory}.
48-
* @throws IllegalArgumentException If the {@code symbols} is either <tt>null</tt>, empty,
48+
* @throws IllegalArgumentException If the {@code symbols} is either {@code null}, empty,
4949
* or contain illegal symbols.
5050
* @see #ComparisonOperator(String[], Arity)
5151
* @deprecated in favor of {@linkplain #ComparisonOperator(String[], Arity)}
@@ -56,10 +56,10 @@ public ComparisonOperator(String[] symbols, boolean multiValue) {
5656
}
5757

5858
/**
59-
* @param symbols Textual representation of this operator (e.g. <tt>=gt=</tt>); the first item is primary
59+
* @param symbols Textual representation of this operator (e.g. {@code =gt=}); the first item is primary
6060
* representation, any others are alternatives. Must match {@literal =[a-zA-Z]*=|[><]=?|!=}.
6161
* @param arity Arity of this operator.
62-
* @throws IllegalArgumentException If the {@code symbols} is either <tt>null</tt>, empty, or contain illegal
62+
* @throws IllegalArgumentException If the {@code symbols} is either {@code null}, empty, or contain illegal
6363
* symbols.
6464
* @since 2.3.0
6565
*/
@@ -75,7 +75,7 @@ public ComparisonOperator(String[] symbols, Arity arity) {
7575
}
7676

7777
/**
78-
* @param symbol Textual representation of this operator (e.g. <tt>=gt=</tt>); Must match
78+
* @param symbol Textual representation of this operator (e.g. {@code =gt=}); Must match
7979
* {@literal =[a-zA-Z]*=|[><]=?|!=}.
8080
* @param multiValue Whether this operator may be used with multiple arguments. This is then
8181
* validated in {@link NodesFactory}.
@@ -88,7 +88,7 @@ public ComparisonOperator(String symbol, boolean multiValue) {
8888
}
8989

9090
/**
91-
* @param symbol Textual representation of this operator (e.g. <tt>=gt=</tt>); Must match
91+
* @param symbol Textual representation of this operator (e.g. {@code =gt=}); Must match
9292
* {@literal =[a-zA-Z]*=|[><]=?|!=}.
9393
* @param arity Arity of this operator.
9494
* @see #ComparisonOperator(String[], boolean)
@@ -99,7 +99,7 @@ public ComparisonOperator(String symbol, Arity arity) {
9999
}
100100

101101
/**
102-
* @param symbol Textual representation of this operator (e.g. <tt>=gt=</tt>); Must match
102+
* @param symbol Textual representation of this operator (e.g. {@code =gt=}); Must match
103103
* {@literal =[a-zA-Z]*=|[><]=?|!=}.
104104
* @param altSymbol Alternative representation for {@code symbol}.
105105
* @param multiValue Whether this operator may be used with multiple arguments. This is then
@@ -111,7 +111,7 @@ public ComparisonOperator(String symbol, String altSymbol, boolean multiValue) {
111111
}
112112

113113
/**
114-
* @param symbol Textual representation of this operator (e.g. <tt>=gt=</tt>); Must match
114+
* @param symbol Textual representation of this operator (e.g. {@code =gt=}); Must match
115115
* {@literal =[a-zA-Z]*=|[><]=?|!=}.
116116
* @param altSymbol Alternative representation for {@code symbol}.
117117
* @param arity Arity of this operator.
@@ -123,7 +123,7 @@ public ComparisonOperator(String symbol, String altSymbol, Arity arity) {
123123
}
124124

125125
/**
126-
* @param symbols Textual representation of this operator (e.g. <tt>=gt=</tt>); the first item
126+
* @param symbols Textual representation of this operator (e.g. {@code =gt=}); the first item
127127
* is primary representation, any others are alternatives. Must match {@literal =[a-zA-Z]*=|[><]=?|!=}.
128128
* @see #ComparisonOperator(String[], boolean)
129129
*/

src/main/java/cz/jirutka/rsql/parser/ast/LogicalNode.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ public abstract class LogicalNode extends AbstractNode implements Iterable<Node>
4343

4444

4545
/**
46-
* @param operator Must not be <tt>null</tt>.
47-
* @param children Children nodes, i.e. operands; must not be <tt>null</tt>.
46+
* @param operator Must not be {@code null}.
47+
* @param children Children nodes, i.e. operands; must not be {@code null}.
4848
*/
4949
protected LogicalNode(LogicalOperator operator, List<? extends Node> children) {
5050
this(operator, new ArrayList<>(children), true);
@@ -61,7 +61,7 @@ protected LogicalNode(LogicalOperator operator, List<? extends Node> children) {
6161
/**
6262
* Returns a copy of this node with the specified children nodes.
6363
*
64-
* @param children Children nodes, i.e. operands; must not be <tt>null</tt>.
64+
* @param children Children nodes, i.e. operands; must not be {@code null}.
6565
* @return a copy of this node with the specified children nodes.
6666
*/
6767
public abstract LogicalNode withChildren(List<? extends Node> children);

src/main/java/cz/jirutka/rsql/parser/ast/Node.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
public interface Node {
3030

3131
/**
32-
* Accepts the visitor, calls its <tt>visit()</tt> method and returns a result.
32+
* Accepts the visitor, calls its {@code visit()} method and returns a result.
3333
*
3434
* <p>Each implementation must implement this methods exactly as listed:
3535
* <pre>{@code
@@ -42,20 +42,20 @@ public interface Node {
4242
* @param param An optional parameter to pass to the visitor.
4343
* @param <R> Return type of the visitor's method.
4444
* @param <A> Type of an optional parameter passed to the visitor's method.
45-
* @return An object returned by the visitor (may be <tt>null</tt>).
45+
* @return An object returned by the visitor (may be {@code null}).
4646
*/
4747
<R, A> R accept(RSQLVisitor<R, A> visitor, A param);
4848

4949
/**
50-
* Accepts the visitor, calls its <tt>visit()</tt> method and returns the result.
50+
* Accepts the visitor, calls its {@code visit()} method and returns the result.
5151
* <p>
5252
* This method should just call {@link #accept(RSQLVisitor, Object)} with
53-
* <tt>null</tt> as the second argument.
53+
* {@code null} as the second argument.
5454
*
5555
* @param visitor The visitor whose appropriate method will be called.
5656
* @param <R> Return type of the visitor's method.
5757
* @param <A> Type of an optional parameter passed to the visitor's method.
58-
* @return An object returned by the visitor (may be <tt>null</tt>).
58+
* @return An object returned by the visitor (may be {@code null}).
5959
*/
6060
<R, A> R accept(RSQLVisitor<R, A> visitor);
6161
}

0 commit comments

Comments
 (0)