OT: javadoc function links without parameter list ?

Sorry for the off-topic post, but at least i am commenting my sources with

Forte/Netbeans autocomment tool ;-).

I wanted to know, if there is an option for javadoc to generate shorter

links to functions, that is without the parameter list (or at least without

fully qualified class names in the parameter list). If so, it would also be

cool to be able to set it via the IDE...

[434 byte] By [JensStutte] at [2007-11-25 16:50:55]
# 1

JensStutte@quidinfo.it wrote:

> I wanted to know, if there is an option for javadoc to generate shorter

> links to functions, that is without the parameter list (or at least without

> fully qualified class names in the parameter list). [snip]

What would this generate for overloads?

public interface Foo {

void run();

void run(java.lang.Object o);

void run(org.omg.corba.Object o);

void run(java.lang.Object o, int x);

// etc.

}

-Jesse

--

Jesse Glick <mailto:jesse.glick@sun.com> x22801

NetBeans, Open APIs <http://www.netbeans.org/>

Glick,Jesse at 2007-7-2 23:49:42 > top of Java-index,Archived Forums,Sun ONE Studio 4...
# 2

Sorry, seems that i was not clear enough:

I meant explicit links within some description (with {@link

SomeClass#SomeFunction}). I do not want them to be displayed to the reader

within the text, though the href of the link must be exact (i did not mean

the links within the Method summary of a class, these must be always

displayed exactly, obviously). I just want to point the reader to the

description of a function, but in the text where the link is placed, the

details does not matter (and make it quite unreadable). I know, i could

create these links by hand ( <a href

="../../package/name/class.html#function">functionname</a> ), but this is

not very handy...

Regards,

Jens Stutte

Jesse Glick

<jesse.glick@To:nbusers@netbeans.org

sun.com> cc:

Subject:Re: OT: javadoc function links without parameter

02/08/2002list ?

23.47

Please

respond to

nbusers

JensStutte@quidinfo.it wrote:

> I wanted to know, if there is an option for javadoc to generate shorter

> links to functions, that is without the parameter list (or at least

without

> fully qualified class names in the parameter list). [snip]

What would this generate for overloads?

public interface Foo {

void run();

void run(java.lang.Object o);

void run(org.omg.corba.Object o);

void run(java.lang.Object o, int x);

// etc.

}

-Jesse

--

Jesse Glick <mailto:jesse.glick@sun.com> x22801

NetBeans, Open APIs <http://www.netbeans.org/>

JensStutte at 2007-7-2 23:49:42 > top of Java-index,Archived Forums,Sun ONE Studio 4...
# 3

If you read the JavaDoc documentation, the {@link} tag supports two

arguments. The first is the link (such as class#function(args)), the

second is the text to display. So, usually you do

{@link myclass#myfunction(arg1, arg2) myfunction}

The documentation explains a lot more, as well. To do this in NB,

simply type a space, and the second argument after the @link or @see

tag.

- Phil DeJarnett

<JensStutte@quidinfo.it> wrote in message

news:netbeans.nbusers/OF1431442C.CE7282E7-ONC1256C0C.00427BE0@hq.quidi

nfo.it...

Sorry, seems that i was not clear enough:

I meant explicit links within some description (with {@link

SomeClass#SomeFunction}). I do not want them to be displayed to the

reader

within the text, though the href of the link must be exact (i did not

mean

the links within the Method summary of a class, these must be always

displayed exactly, obviously). I just want to point the reader to the

description of a function, but in the text where the link is placed,

the

details does not matter (and make it quite unreadable). I know, i

could

create these links by hand ( <a href

="../../package/name/class.html#function">functionname</a> ), but this

is

not very handy...

Regards,

Jens Stutte

DeJarnett,Phil at 2007-7-2 23:49:42 > top of Java-index,Archived Forums,Sun ONE Studio 4...