How can I link JavaDoc to another class?
I am trying to write a javadoc that displays the javadoc from another method, for example:
private List<Object> list;
/**
* {@link list#indexOf(Object)}
*/
int getMyIndex(Object o) {
return list.indexOf(o);
}
This will give me the javadoc link when I use the method getMyIndex()
. But I want the eclipse to actually show (!) The Javadoc from the method I referenced in @link
.
Of course, this is not a link. The link does what it should do in this case.
But what do I need to use to somehow "import" the foreign javadoc there?
+3
source to share
1 answer
No, there is no such tag or functionality as far as I know. See the javadoc tag list for details .
From link
Tag | Introduced in JDK / SDK
-----------------------------------
@author 1.0
{@code} 1.5
{@docRoot} 1.3
@deprecated 1.0
@exception 1.0
{@inheritDoc} 1.4
{@link} 1.2
{@linkplain} 1.4
{@literal} 1.5
@param 1.0
@return 1.0
@see 1.0
@serial 1.2
@serialData 1.2
@serialField 1.2
@since 1.1
@throws 1.2
{@value} 1.4
@version 1.0
+8
source to share