Skip to content

Commit a029b89

Browse files
committed
minor refactor: fix javadoc warnings
1 parent 3c38dd3 commit a029b89

9 files changed

Lines changed: 12 additions & 12 deletions

File tree

src/main/java/org/apache/groovy/util/concurrent/ConcurrentReferenceHashMap.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1950,7 +1950,7 @@ protected abstract class HashIterator {
19501950
advance();
19511951
}
19521952

1953-
/** {@inheritDoc} */
1953+
/** @return {@code true} if more elements remain (delegates to {@link #hasNext()}) */
19541954
public boolean hasMoreElements() {
19551955
return hasNext();
19561956
}
@@ -1981,7 +1981,7 @@ final void advance() {
19811981
}
19821982
}
19831983

1984-
/** {@inheritDoc} */
1984+
/** @return {@code true} if there is a next live entry to iterate to */
19851985
public boolean hasNext() {
19861986
while (nextEntry != null) {
19871987
if (nextEntry.key() != null) {
@@ -2009,7 +2009,7 @@ HashEntry<K, V> nextEntry() {
20092009
return lastReturned;
20102010
}
20112011

2012-
/** {@inheritDoc} */
2012+
/** Removes the last entry returned by the iterator. */
20132013
public void remove() {
20142014
if (lastReturned == null) {
20152015
throw new IllegalStateException();

src/main/java/org/codehaus/groovy/ast/ClassNode.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -800,7 +800,6 @@ public FieldNode addFieldFirst(String name, int modifiers, ClassNode type, Expre
800800
*
801801
* @param node the {@link PropertyNode} to add, must not be {@code null}
802802
* @see #addField(FieldNode)
803-
* @see #removeProperty(String)
804803
* @see PropertyNode
805804
*/
806805
public void addProperty(PropertyNode node) {

src/main/java/org/codehaus/groovy/ast/GenericsType.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,9 @@ public ClassNode getLowerBound() {
262262
}
263263

264264
/**
265-
* Returns the upper bounds for this wildcard or placeholder type (e.g., Bounds in "? extends Bound" or "T extends Bound1 & Bound2"),
265+
* Returns the upper bounds for this wildcard or placeholder type
266+
* (e.g., {@code Bound} in {@code ? extends Bound} or
267+
* {@code Bound1 & Bound2} in {@code T extends Bound1 & Bound2}),
266268
* or null if this type has no upper bounds.
267269
*
268270
* @return array of upper bound {@link ClassNode}s, or null

src/main/java/org/codehaus/groovy/ast/GroovyCodeVisitor.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -363,7 +363,7 @@ default void visit(final Statement statement) {
363363
void visitFieldExpression(FieldExpression expression);
364364

365365
/**
366-
* Visits a method pointer expression (object.&methodName).
366+
* Visits a method pointer expression ({@code object.&methodName}).
367367
*
368368
* @param expression the {@link MethodPointerExpression} to process
369369
*/

src/main/java/org/codehaus/groovy/ast/decompiled/ClassStub.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
* <p><strong>Thread Safety:</strong> ClassStub instances are typically constructed once and then
4040
* treated as immutable. They are safe for concurrent read access after initialization.
4141
*
42-
* @see AsmDecompiler#parseClass(String, int, String, String, String[])
42+
* @see AsmDecompiler#parseClass(java.net.URL)
4343
* @see DecompiledClassNode#DecompiledClassNode(ClassStub, AsmReferenceResolver)
4444
*/
4545
public class ClassStub extends MemberStub {

src/main/java/org/codehaus/groovy/ast/decompiled/DecompiledClassNode.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@
9696
* <p>Groovy embeds compilation timestamps in synthetic static field names for change detection.
9797
* {@link #getCompilationTimeStamp()} decodes this metadata using {@link org.codehaus.groovy.classgen.Verifier#getTimestampFromFieldName(String)}.
9898
*
99-
* @see AsmDecompiler#parseClass(String, int, String, String, String[])
99+
* @see AsmDecompiler#parseClass(java.net.URL)
100100
* @see AsmReferenceResolver
101101
* @see ClassStub
102102
* @see LazyFieldNode

src/main/java/org/codehaus/groovy/ast/expr/ExpressionTransformer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
* <p>This is a functional interface and can be implemented as a lambda expression.
4242
*
4343
* @see org.codehaus.groovy.ast.ClassCodeExpressionTransformer for abstract transformer base class
44-
* @see TransformingCodeVisitor for visitor using transformers
44+
* @see org.codehaus.groovy.ast.TransformingCodeVisitor for visitor using transformers
4545
*/
4646
@FunctionalInterface
4747
public interface ExpressionTransformer {

src/main/java/org/codehaus/groovy/ast/stmt/ExpressionStatement.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@
2828
* an expression must be treated as a statement (e.g., method calls, assignments, or other
2929
* side-effect-producing expressions). The expression is evaluated and its result is discarded.
3030
*
31-
* @throws IllegalArgumentException if the expression is null
3231
* @see {@link Expression}
3332
* @see {@link Statement}
3433
* @see {@link ReturnStatement}

subprojects/groovy-xml/src/main/java/groovy/xml/XmlUtil.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -767,7 +767,7 @@ public static void setFeatureQuietly(SAXParserFactory factory, String feature, b
767767
}
768768

769769
/**
770-
* Streams XML events from the supplied {@link Reader} using a hardened
770+
* Streams XML events from the supplied {@link java.io.Reader} using a hardened
771771
* StAX {@link javax.xml.stream.XMLInputFactory}. The returned stream
772772
* lazily pulls events; closing the stream closes the underlying reader.
773773
* <p>
@@ -782,7 +782,7 @@ public static java.util.stream.Stream<javax.xml.stream.events.XMLEvent> events(j
782782
}
783783

784784
/**
785-
* Streams XML events from the supplied {@link Reader} using a hardened
785+
* Streams XML events from the supplied {@link java.io.Reader} using a hardened
786786
* StAX {@link javax.xml.stream.XMLInputFactory}. The returned stream
787787
* lazily pulls events; closing the stream closes the underlying reader.
788788
*

0 commit comments

Comments
 (0)