dev@glassfish.java.net

Re: referencing Class<T> in javadoc?

From: Marina Vatkina <Marina.Vatkina_at_Sun.COM>
Date: Thu, 02 Mar 2006 21:59:07 -0800

OK. This will do (though seems like a javadoc bug to me).

Next challenge: '@' in the javadoc's example. The following
javadoc:

  * <blockquote><pre>
  * Example 1:
  * @Column(name="DESC", nullable=false, length=512)
  * public String getDescription() { return description; }
  *
...
  *
  * </pre></blockquote>

causes:
     [javadoc]
/faith4/gf/glassfish/persistence-api/src/java/javax/persistence/Column.java:57:
warning - @Column(name="DESC", is an unknown tag.

And(!) all the text after "Example 1" being <blockquote>-ed.
Changing "@" to "." resolves the issue (but makes the javadoc wrong :)).

thanks,
-marina


Sanjeeb Kumar Sahoo wrote:
> Is *_at_see Foo#bar(Class) *not enough? Why do you need to specify
> Class<T>? After all Foo can only have one of the two methods:
> bar(Class<T>) and bar(Class), not both.
>
> Thanks,
> Sahoo
> Marina Vatkina wrote:
>
>> Team,
>>
>> How would I reference in javadoc (e.g. @see) a method that uses Class<T>
>> as an argument (without dropping argument all together)?
>>
>> "<T>" causes the following 3 warnings:
>>
>> [javadoc] ... warning - Tag @see:illegal character: "60" in
>> Foo#bar(Class<t>)"
>> [javadoc] ... warning - Tag @see:illegal character: "62" in
>> Foo#bar(Class<t>)"
>> [javadoc] ... warning - Tag @see: can't find bar(Class<t>) in Foo
>>
>> I tried "&lt;T&gt;" but got even more warnings :(.
>>
>> Please help.
>>
>> thanks,
>> -marina
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe_at_glassfish.dev.java.net
>> For additional commands, e-mail: dev-help_at_glassfish.dev.java.net
>>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe_at_glassfish.dev.java.net
> For additional commands, e-mail: dev-help_at_glassfish.dev.java.net
>