opendev/gerrit
Code Issues Proposed changes

Fix warning "Javadoc: Malformed reference (missing end space separator)"

Browse Source 
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
This commit is contained in:
Matthias Sohn
2020-10-10 23:38:48 +02:00
parent aed17b3d86
commit 029a9ddf01
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
java/com/google/gerrit/server/CommentContextLoader.java
View File

@@ -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