• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Javadoc problem with generics

 
Edwin Dalorzo
Ranch Hand
Posts: 961
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I am having trouble documenting some of my classes that use generic collections. It seem that the {@link} tag does not support this:


{@link suncertify.db.DatabaseImpl#selectByCriteria(Map<String,String> }

When I run javadoc I receive an exception and the link is not generated.

Do you guys have faced this problem? Do you have any idea about how to solve it?

Thanks in advance for all your help and support!
 
Jeremy Botha
Ranch Hand
Posts: 125
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
change the < to < and the > to >

they're the html escape codes for < and > respectively.

Edit: well, that worked better than I thought it would.

change < to &lt; and > to &gt;

Jeremy
[ October 19, 2006: Message edited by: Jeremy Botha ]
 
Edwin Dalorzo
Ranch Hand
Posts: 961
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I am affraid Jeremy, that I had already tried that. I am still getting an invalid character exception from javadoc, pointing to the & charcter.

I am using ant to generat the assigment jar and javadoc and everything, but I do not think this is the problem. I think this may be a bug in javadoc.exe.

Surprisingly the {@code } tag does not suffer this problem. Weird, huh?
[ October 19, 2006: Message edited by: Edwin Dalorzo ]
 
Jeremy Botha
Ranch Hand
Posts: 125
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
That is frustrating.

J
 
Barry Gaunt
Ranch Hand
Posts: 7729
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Is this the javadoc bug you are a victim of?
 
Edwin Dalorzo
Ranch Hand
Posts: 961
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Yes, Barry. I am affraid it is.

I will try the suggested workaround and let you know how it turns out.


Do not use generics when referencing methods with generics, just use the collection type instead.
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic