Javadoc link tag with List parameter

Question

I was writing a javadoc link tag, with the parameter List as something like this.

{@link #getVersionMetadata(String, String, String, List<String>)

It does not feel right to me. And escaping the < and > does not seem acceptable by the IDE.

{@link #getVersionMetadata(String, String, String, List<String>)

What is the correct way to use List<> with javadoc @link?

Answer 1

An alternative which works in IntelliJ and actually links to the classes. I'm unsure how it will appear in other IDEs.

{@link List}<{@link String}>

Answer 2

You can change the text in the link to reflect the list type parameter like so...

   {@link #getVersionMetadata(String, String, String, List) getVersionMetaData(String,String,String,List<String>)}

Answer 3

That should work:

{@link #getVersionMetadata(String, String, String, List)}