aspose file tools*
The moose likes IDEs, Version Control and other tools and the fly likes javadoc frustration using see tag. Big Moose Saloon
  Search | Java FAQ | Recent Topics | Flagged Topics | Hot Topics | Zero Replies
Register / Login


Win a copy of Spring in Action this week in the Spring forum!
JavaRanch » Java Forums » Engineering » IDEs, Version Control and other tools
Bookmark "javadoc frustration using see tag." Watch "javadoc frustration using see tag." New topic
Author

javadoc frustration using see tag.

Karl Krasnowsky
Ranch Hand

Joined: Jan 16, 2009
Posts: 97
Sorry for this seemingly lame question, but I can't get my @see tag (no joke intended) to work in my extended exception class. Here's what I'm trying to do:



according to suns javadoc guide, here's the formats that should work:



(I'm using the @see Class#Constructor(Type, Type...) format)

but I'm getting the warning:


upon javadoc execution. what am I doing wrong?


[SCJP 6]
[SCBCD in process]
Peter Johnson
author
Bartender

Joined: May 14, 2008
Posts: 5836
    
    7

Is there a typo in the post or in your code? Look at the class name you posted, and then at the name of the method you posted. That method is not a constructor.


JBoss In Action
Karl Krasnowsky
Ranch Hand

Joined: Jan 16, 2009
Posts: 97
Peter Johnson wrote:Is there a typo in the post or in your code? Look at the class name you posted, and then at the name of the method you posted. That method is not a constructor.


Oops, yeah, it's a typo. Now let me fix that...

But the file is correct here, same funky result.
Christophe Verré
Sheriff

Joined: Nov 24, 2005
Posts: 14688
    
  16

@see Class#method(Type, Type,...)

For a method called doSomething() of a class MyClass, would you use @see MyClass#method() ? No, you would use @see MyClass#doSomething.

@see Class#Constructor(Type, Type...)

Same here. Would you use @see MyClass#Constructor() ? No, you would use @see MyClass#MyClass().

Try @see Exception#Exception(java.lang.String).


[My Blog]
All roads lead to JavaRanch
Karl Krasnowsky
Ranch Hand

Joined: Jan 16, 2009
Posts: 97
Christophe Verré wrote:
@see Class#method(Type, Type,...)

For a method called doSomething() of a class MyClass, would you use @see MyClass#method() ? No, you would use @see MyClass#doSomething.

@see Class#Constructor(Type, Type...)

Same here. Would you use @see MyClass#Constructor() ? No, you would use @see MyClass#MyClass().

Try @see Exception#Exception(java.lang.String).


Hey, I didn't write the documentation, if it were written like this:



Then it would seem obvious. Besides, of course I attempted the format you stated. In fact, the IDE that I'm using even recommended it and it failed as well. I've been around this a few times now and it doesn't resolve.
 
I agree. Here's the link: http://aspose.com/file-tools
 
subject: javadoc frustration using see tag.