geronimo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Alex Blewitt <Alex.Blew...@ioshq.com>
Subject Re: [JSR-88] JavaDoc
Date Thu, 21 Aug 2003 07:05:36 GMT
I haven't bothered putting JD in the JavaMail API. I see the API as 
something which is required to compile/run code, but not to develop it. 
If developers need the doc, they can always download the full J2EE 
JavaDoc which will contain most of the standard code (e.g. the 
javax.management stuff).

Don't know whether it applies as much to JSRs that aren't part of the 
core J2EE API; that might be another issue.

On Wednesday, Aug 20, 2003, at 22:17 Europe/London, Cabrera, Alan wrote:

> Is it a good idea to put JavaDocs in our API code?  For mx4j, the JMX 
> specs
> group suggested that we don't put comments into our clean-room API 
> code so,
> we didn't.  The idea being that there should be a single source for 
> the spec
> and JavaDocs, this being www.jcp.org.  I see their point but do not 
> feel
> strongly about it.
>
>
> Regards,
> Alan
>
>> -----Original Message-----
>> From: Aaron Mulder [mailto:ammulder@alumni.princeton.edu]
>> Sent: Wednesday, August 20, 2003 6:37 PM
>> To: geronimo-dev@incubator.apache.org
>> Subject: [PATCH] [JSR-88] JavaDoc
>>
>>
>> 	I've started adding the JavaDoc to the JSR-88 spec
>> tree.  Here are the first couple packages; the ones we're
>> currently implementing.  It's based on the Sun JavaDoc, but
>> with lots of typos fixed and a couple clarifications.


Mime
View raw message