dev@glassfish.java.net

Re: javadocs for glassfish and related modules.

From: Lloyd Chambers <Lloyd.Chambers_at_Sun.COM>
Date: Fri, 04 Dec 2009 11:56:07 -0800

"we should only publish doc for the exported public packages"

Ideally, yes. But there can be packages which have a few public classes and some private ones.

I use @org.glassfish.external.arc.Taxonomy to declare such things eg:

@Taxonomy( Stability.PRIVATE )

@Taxonomy( NOT_AN_INTERFACE )



On Dec 4, 2009, at 11:45 AM, Ludovic Champenois wrote:

> Siraj Ghaffar wrote:
>> There are some interfaces in that package - however I see your point in not publishing javadocs for packages that are unlikely to be used by end users. That makes sense. One interface in that package that might be useful for those using the embedded APIs would be the CommandRunner interface that allows you to run administrative commands.
>>
>> Rajiv Mordani wrote:
>>> Siraj, Jane,
>>> We want to publish javadocs for the APIs that developers can use, not the implementation classes. If there are some packages from admin that are useful for end users / developers that are not being published let me know. However some things that I see in the admin modules didn't seem to make sense for end users (at least that's what I think) so I did not include it.
>>>
>>> - Rajiv
> In fact, we should only publish doc for the exported public packages that have been declared as such in the ARC cases, right?
>
> Ludo
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe_at_glassfish.dev.java.net
> For additional commands, e-mail: dev-help_at_glassfish.dev.java.net
>

Lloyd Chambers
lloyd.chambers_at_sun.com
GlassFish Team