Win a copy of Clojure in Action this week in the Clojure forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

javadoc frustration using see tag.

 
Karl Krasnowsky
Ranch Hand
Posts: 97
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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?

 
Peter Johnson
author
Bartender
Posts: 5852
7
Android Eclipse IDE Ubuntu
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
 
Karl Krasnowsky
Ranch Hand
Posts: 97
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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
Pie
Posts: 14691
16
Eclipse IDE Ubuntu VI Editor
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
@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).
 
Karl Krasnowsky
Ranch Hand
Posts: 97
  • 0
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
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.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic