wood burning stoves 2.0*
The moose likes Beginning Java and the fly likes How to make the the @see linkable in the javadoc Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of The Java EE 7 Tutorial Volume 1 or Volume 2 this week in the Java EE forum
or jQuery UI in Action in the JavaScript forum!
JavaRanch » Java Forums » Java » Beginning Java
Bookmark "How to make the the @see linkable in the javadoc" Watch "How to make the the @see linkable in the javadoc" New topic
Author

How to make the the @see linkable in the javadoc

Zee Ho
Ranch Hand

Joined: Jul 20, 2004
Posts: 128
Hi. All, I try to generate the javadoc of my own class and encounter some problem.

/**
* Converts to a string represents the data in this object, a emtpty string
* ("") will return as default value if the object is <code>null</code>
* .</p>
* @param object the object to check may be <code>null</code>.
* @return Same value as invoke toString of the passed object if it is
* <code>not null</code>, else the empty String will return
* @see suncertify.utility.Utility#defaultString(java.lang.String)
* @see String#toString(Object)
*/

for the 1st one it works fine. but I want to make the second one avaliable, like most 3rd party provider do. and how? since I only got a common text for the 2nd @see?





SCJP 1.4<br />SCWCD 1.3<br />SCJD<br />SCBCD<br />IBM Xml Cert in progress
Zee Ho
Ranch Hand

Joined: Jul 20, 2004
Posts: 128
I use the following command

javadoc -sourcepath "G:\Eclipse\workspace\su
ncertify\src" -d "G:\Eclipse\workspace\suncertify\doc" -link http://java.sun.co
m/j2se/1.4.2/docs/api -subpackages suncertify
Zee Ho
Ranch Hand

Joined: Jul 20, 2004
Posts: 128
I use jdk 1.42_07
Jeroen Wenting
Ranch Hand

Joined: Oct 12, 2000
Posts: 5093
You must use fully qualified classnames for all classes you want linked, else the javadoc compiler can't create the links. So putting in java.lang.String and java.lang.Object should probably do the trick.

Mind I'm no Javadoc expert, maybe an extra step is required to link to entries in external javadoc packages.


42
Zee Ho
Ranch Hand

Joined: Jul 20, 2004
Posts: 128
I have already found the answer, the syntax is correct, the java.lang is not necessay, as the convention of java all those package will be introduced automatically, the root cause is the version of jdk, I use the jdk 1.4.1 before, seems it is stale, I upgrade it to 1.4.2_07 all the things became perfect.
David O'Meara
Rancher

Joined: Mar 06, 2001
Posts: 13459

"ZeeHo",
Please see the request to change your display name here. Accounts with invalid display anmes eventually get deleted, often without warning

thanks,
Dave.
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: How to make the the @see linkable in the javadoc