dev@glassfish.java.net

Re: javadocs?

From: Jane Young <Jane.Young_at_Sun.COM>
Date: Tue, 31 Mar 2009 13:25:34 -0700

I'm working on this and will get it published on glassfish.dev.java.net.

Thanks,
Jane


Jeanfrancois Arcand wrote:
>
>
> Bill Shannon wrote:
>> How do I generate the javadocs for v3?
>>
>> I tried "mvn javadoc:javadoc" and it did a *ton* of work, generating
>> lots of "site/apidocs" directories, but I couldn't tell which one was
>> the one that combined the right pieces for the public javadocs, similar
>> to https://glassfish.dev.java.net/nonav/javaee5/api/index.html.
>>
>> (Maybe someone is already publishing these for v3 on a regular basis
>> and I don't need to build them myself?)
>
> +1
>
> Since we are all maven, why not publishing on glassfish.dev.java.net
> the result of mvn site? It include javadocs and XREF and this is quite
> helpful IMO for new contributors.
>
> -- Jeanfrancois
>
>
>
>>
>> Also, there's lots of warnings generated. For example:
>>
>>
>> [WARNING]
>> /cache/tmp/v3/transaction/javax.transaction/src/main/java/javax/transa
>> ction/TransactionSynchronizationRegistry.java:108: warning - Tag
>> @link: referenc
>> e not found: java.util.Map#put(Object, Object)
>> [WARNING] javadoc: warning - Multiple sources of package comments
>> found for pack
>> age "javax.servlet.http"
>> [WARNING]
>> /cache/tmp/v3/web/javax.servlet/src/main/java/javax/servlet/AsyncConte
>> xt.java:123: warning - Tag @link: missing '#': "forward(String)"
>> [WARNING]
>> /cache/tmp/v3/connectors/javax.resource/src/main/java/javax/resource/s
>> pi/work/SecurityInflowContext.java:137: warning: unmappable character
>> for encodi
>> ng ASCII
>> [WARNING] * A resource adapter might use the
>> <code>CallerPrincipalCallback</code
>> > ???to
>> [WARNING] ^
>> [WARNING]
>> /cache/tmp/v3/common/glassfish-api/src/main/java/org/glassfish/api/dep
>> loyment/archive/WritableArchive.java:62: warning - @returns is an
>> unknown tag.
>>
>>
>> Does anyone care about these?
>>
>> ---------------------------------------------------------------------
>> 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
>