Javadoc link to method in other class

Question

Currently I m referencing methods in other classes with this Javadoc syntax    see   link com my package Class method      And in what I understand from the documentation this is the correct way to do this  But now to the funny part  or frustrating  When I generate this javadoc I first of all get following error   warning - Tag  see illegal character   123  in    link com my package Class method     warning - Tag  see illegal character   64  in    link com my package Class method     warning - Tag  see  reference not found    link com my package Class method      The Generated HTML code of this is        lt code gt com my package Class method    lt  code gt        And of course I have no link  Can anyone tell me what s happening  and any hints on how to fix this   According to the ASCII table characters 123 and 64 for wold represent   and    so why aren t these characters valid when this syntax is correct according to the documentation

User · Accepted Answer

For the Javadoc tag  see  you don t need to use  link  Javadoc will create a link for you   Try   see com my package Class method     Here s more info about  see

User · Answer

Aside from  see  a more general way of refering to another class and possibly method of that class is   link somepackage SomeClass someMethod paramTypes    This has the benefit of being usable in the middle of a javadoc description   From the javadoc documentation  description of the  link tag       This tag is very simliar to  see     both require the same references and accept exactly the same syntax for package class member and label  The main difference is that   link  generates an in-line link rather than placing the link in the  See Also  section  Also  the   link  tag begins and ends with curly braces to separate it from the rest of the in-line text

User · Answer

So the solution to the original problem is that you don t need both the   see  and the    link      references on the same line   The   link  tag is self-sufficient and  as noted  you can put it anywhere in the javadoc block  So you can mix the two approaches          some javadoc stuff      link com my package Class method       more stuff     see com my package AnotherClass

[java] Javadoc link to method in other class

Examples related to java

Examples related to javadoc