CODEWITHSUNDEEP
tagshyperlinkjavadoc
DPM
DPM

Reputation: 2030

Linking to @see tag from within javadoc comment

I'm writing javadoc for a class and a particular paragraph has to be backed by an external link. My idea is to put this link in @see tag at the end of the class' javadoc and at the same time link the paragraph to the @see tag somehow, but I don't know how to do this. Maybe my approach is wrong and I should just include the link in the particular paragraph where is relevant instead of merging it with the rest of the @see tags section.

Upvotes: 1

Views: 277

Answers (1)

Simulant
Simulant

Reputation: 20122

the @seeTag is to reference other classes. If you want a simple html-link to the internet use a html link in your documentation text:

/**  
* here comes a link <a href="http://google.com">http://google.com</a>  
*/

you can also do this with the @see Tag infront of the html link to get the link listed at the bottom of your class.

Upvotes: 1

Related Questions