• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Paul Clapham
  • Tim Cooke
  • Jeanne Boyarsky
  • Liutauras Vilda
Sheriffs:
  • Frank Carver
  • Henry Wong
  • Ron McLeod
Saloon Keepers:
  • Tim Moores
  • Frits Walraven
  • Tim Holloway
  • Stephan van Hulst
  • Carey Brown
Bartenders:
  • Al Hobbs
  • Piet Souris
  • Himai Minh

How to make the the @see linkable in the javadoc

 
Ranch Hand
Posts: 128
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
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?



 
Zee Ho
Ranch Hand
Posts: 128
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
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
Posts: 128
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
I use jdk 1.42_07
 
Ranch Hand
Posts: 5093
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
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.
 
Zee Ho
Ranch Hand
Posts: 128
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
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.
 
Rancher
Posts: 13459
Android Eclipse IDE Ubuntu
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
"ZeeHo",
Please see the request to change your display name here. Accounts with invalid display anmes eventually get deleted, often without warning

thanks,
Dave.
 
Our first order of business must be this tiny ad:
the value of filler advertising in 2021
https://coderanch.com/t/730886/filler-advertising
reply
    Bookmark Topic Watch Topic
  • New Topic