summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Sohn <matthias.sohn@sap.com>2020-10-10 23:38:48 +0200
committerMatthias Sohn <matthias.sohn@sap.com>2020-10-11 09:25:47 +0200
commit029a9ddf01584f00fe97ced9260aa4cd7dee3cff (patch)
tree93e473c636f08bcb3f56d106d5ecfbdf56101768
parentaed17b3d86227c64baba7d3346762a34f3b82c2c (diff)
Fix warning "Javadoc: Malformed reference (missing end space separator)"
Javadoc doesn't support generic parameters in @link tags and renders {@link List<ContextLineInfo>} as 'Link' without adding a link. Work around this by removing the generic type parameter and setting an explicit label including the generic type parameter. This shows the desired text and renders a link to the List class. See https://bugs.java.com/bugdatabase/view_bug.do?bug_id=6422214 Change-Id: I34aa7b4dec034a3954b328a4e5922e4cb5ddffec
-rw-r--r--java/com/google/gerrit/server/CommentContextLoader.java3
1 files changed, 2 insertions, 1 deletions
diff --git a/java/com/google/gerrit/server/CommentContextLoader.java b/java/com/google/gerrit/server/CommentContextLoader.java
index 7f846932b3..bbc7cf3e62 100644
--- a/java/com/google/gerrit/server/CommentContextLoader.java
+++ b/java/com/google/gerrit/server/CommentContextLoader.java
@@ -63,7 +63,8 @@ public class CommentContextLoader {
/**
* Returns an empty list of {@link ContextLineInfo}. Clients are expected to call this method one
- * or more times. Each call returns a reference to an empty {@link List<ContextLineInfo>}.
+ * or more times. Each call returns a reference to an empty {@link List
+ * List&lt;ContextLineInfo&gt;}.
*
* <p>A single call to {@link #fill()} will cause all list references returned from this method to
* be populated. If a client calls this method again with a comment that was passed before calling