Menu
I get the following warning from javadoc:
warning - Tag @link:illegal character: "47"
when I have something like
/**
* {@link /WebRoot/WEB-INF/tiles/templates/bob.jsp} for the template responsible
*/
in my code.
What is the best way to link to the jsp file in my javadoc comments?
444
Javadoc provides the @link inline tag for referencing the members in the Java classes. We can think of the @link tag as similar to the anchor tag in HTML, which is used to link one page to another via hyperlinks.
This inserts an inline link with a visible text label. The text label points to the documentation for the specified package, class, or member name. This tag can be used everywhere, including an overview, package, class, method, field, etc.
The @link tag is specifically used to link to the Javadoc of other classes and methods.
Using Tags. For example, most Javadoc comments for methods include " @param " and " @return " tags when applicable, to describe the method's parameters and return value. The " @param " tag should be followed by the parameter's name, and then a description of that parameter.
have you tried using html-links in your JavaDoc? They do not need a @-Tag annotation.
/**
* <a href="./WebRoot/WEB-INF/tiles/templates/bob.jsp">click me</a>
*/
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
