@see/{@link} Question

When you specify an @see or {@link} tag to look at, let's say java.util.Properties, do I have to specify the url to that Javadoc page using an HTML anchor element? In the articleHow to Write Doc Comments for the Javadoc Tool they just specified the class name and it came back as a link in the generated document. Granted they are probably using a class within their package but I figured I could just specify the full package name for a standard Java class and it would automatically convert it into a link (assuming the package has some sort of way to reference that Javadoc). I'm wondering if I'm doing something wrong or if I'm just going to have to suck it up and have to deal with littering my comments with HTML anchor elements.

I'm using Eclipse 3.2.1 with an Ant build file. My Ant version is 1.7.0.

[834 byte] By [anthony.c.smith@insightbb.coma] at [2007-11-26 18:44:50]

«« send xml file and recieve xml in response from servlet
»» return a param to main method then using switch

# 1

If you're link to a class you're documenting, then you just supply @see MyClass.

However, if you're linking to a class you're not documenting, then to avoid

littering your source file doc comments with <a> tags, instead use, say,

@see java.util.Properties and use the -link or -linkoffline option, as described

at:

http://java.sun.com/j2se/1.5.0/docs/tooldocs/windows/javadoc.html#link

-Doug

dhkramera at 2007-7-9 6:18:44 >

top of Java-index,Developer Tools,Debugging and Profiling Tool APIs...

# 2

Thank you very much. I believe that is what I was looking for. I'll see if I can find how to use this solution with Ant. Thanks again.

anthony.c.smith@insightbb.co at 2007-7-9 6:18:44 >

# 3

Here is how to use it with Ant.

<javadoc packagenames="com.packagename.**"

sourcepath="${src.path}"

destdir="${javadoc.path}"

classpathref="classpath"

author="true"

version="true"

use="true"

windowtitle="Digital Asset Management API">

</javadoc>

anthony.c.smith@insightbb.co at 2007-7-9 6:18:44 >

Java programming resources: FAQs, tutorials, compiler and browser download sites, documentation, books lists, IDEs, etc.

@see/{@link} Question

Developer Tools New Topic

Developer Tools Hot Topic

Developer Tools

All Classified