Velocity Reviews - Computer Hardware Reviews

Velocity Reviews > Newsgroups > Programming > Java > Javadoc including "java.lang.String" instead of just "String" for return values

Reply
Thread Tools

Javadoc including "java.lang.String" instead of just "String" for return values

 
 
Randolf Richardson
Guest
Posts: n/a
 
      02-02-2007
How does one get the javadoc utility to show just "String" instead of
"java.lang.String" in its output?

I've noticed that, for example, Sun's "awt.TextField.ParamString()"
method is documented as follows, and I'd like to make mine appear this way
for extremely well-known objects such as "String" as well:

protected String paramString()

Thanks in advance.

--
Randolf Richardson - kingpin+
The Lumber Cartel, local 42 (Canadian branch)
http://www.lumbercartel.ca/
 
Reply With Quote
 
 
 
 
Thomas Fritsch
Guest
Posts: n/a
 
      02-02-2007
Randolf Richardson wrote:
> How does one get the javadoc utility to show just "String" instead
> of "java.lang.String" in its output?
>
> I've noticed that, for example, Sun's "awt.TextField.ParamString()"
> method is documented as follows, and I'd like to make mine appear this
> way for extremely well-known objects such as "String" as well:
>
> protected String paramString()


You can use the "-link" (or may be the "linkoffline") option in your
javadoc-run. This will for example generate
protected String paramString()
where "String" is a HTML-link to the JavaDoc page of java.lang.String.

See http://java.sun.com/j2se/1.5.0/docs/...adoc.html#link
http://java.sun.com/j2se/1.5.0/docs/...ml#linkoffline

--
Thomas
 
Reply With Quote
 
 
 
 
Randolf Richardson
Guest
Posts: n/a
 
      02-03-2007
On Fri, 02 Feb 2007 02:21:09 -0800, Thomas Fritsch
<> wrote:
> Randolf Richardson wrote:
>> How does one get the javadoc utility to show just "String" instead
>> of "java.lang.String" in its output?
>> I've noticed that, for example, Sun's
>> "awt.TextField.ParamString()" method is documented as follows, and I'd
>> like to make mine appear this way for extremely well-known objects
>> such as "String" as well:
>>
>> protected String paramString()

>
> You can use the "-link" (or may be the "linkoffline") option in your
> javadoc-run. This will for example generate
> protected String paramString()
> where "String" is a HTML-link to the JavaDoc page of java.lang.String.
>
> See
> http://java.sun.com/j2se/1.5.0/docs/...adoc.html#link
> http://java.sun.com/j2se/1.5.0/docs/...ml#linkoffline


Thanks for the suggestion, and for the URI. It looks like "-link" is not
exactly what I'm after, but in reading the document you referenced I found
my answer -- for those who might be interested, the "-noqualifier"
parameter solved my problem (specifically, I'm using "-noqualifier
java.lang" since this section of the Java API is so well-known).

Your help is greatly appreciated, and was what I needed to get the right
solution. Thanks again!

--
Randolf Richardson - kingpin+
The Lumber Cartel, local 42 (Canadian branch)
http://www.lumbercartel.ca/
 
Reply With Quote
 
 
 
Reply

Thread Tools

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
Re: Unpack less values from function's return values Chris Rebert Python 1 05-28-2009 02:47 PM
hello everybody,there are some new pictures just uploaded,including xmfengyi2005@gmail.com Computer Support 0 04-18-2008 09:27 AM
Why use "return (null);" instead of "return null;" ? Carl Java 21 08-24-2006 04:33 AM
what value does lack of return or empty "return;" return Greenhorn C Programming 15 03-06-2005 08:19 PM
Is it possible to return just a DataTable from a WebMethod, instead of DataSet? Tim Medcalf ASP .Net Web Services 1 11-05-2003 04:56 AM



Advertisments