geronimo-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Raveendranath, Rohith (LNG - AUS)" <>
Subject RE: [PATCH] [JSR-88] JavaDoc
Date Sat, 23 Aug 2003 05:07:32 GMT
can't agree more ....

well i am in this group though for couple of days , seeing mails floating ,
was just wondering where to start :))

i feel this could help us have a better look at the application as and when
we write the docs .. 

its always exciting to be a part of a global cause in what so ever way 

so count me in pleaseee ( though i donno much whats happening ;)) and guide
me what i have to do , where to start 


-----Original Message-----
From: Jules Gosnell []
Sent: Friday, 22 August 2003 7:29 PM
Subject: Re: [PATCH] [JSR-88] JavaDoc

This looks like a task that could easily be split into e.g. 
subpackages/groups-of-files and done concurrently by a number of people 
eager to get involved, but not knowing quite where to start...

If someone just coordinated their registering interest, being allocated 
a package, pointed to Sun's API and the collation of the results, I 
think this could be done fairly quickly and painlessly - APIs@home :-)

If the process worked nicely for JSR88, it could be extended for all 
APIs that we need. This is one place where Open Source, particularly on 
a project with a large community, has an enormous headstart... let's 
leverage it.


Bill de hÓra wrote:

> Alex Blewitt wrote:
>> The only problem is that there's a lot of stuff to be documented; in 
>> JavaMail, for example, the API is 100 classes and around 800 methods 
>> -- even assuming a conservative 3 lines per method and 5 lines per 
>> class, that's almost 3000 lines of text. It's going to take a long 
>> time to put anything in there.
>> I'd say go for it if you're willing to put the effort in for the 
>> JavaDoc, but it should be a low priority overall.
> Alex,
> Agree on the level of effort involved, however I /believe/ it may be 
> the case that for a Sun/JSR API, you have to include the Javadoc (ie 
> the raw code isn't sufficient). I think it's worth checking what Sun's 
> lic policy with this.
> Bill de hÓra

 * Jules Gosnell
 * Partner
 * Core Developers Network (Europe)

This e-mail is for the use of the intended recipient(s) only.  If you have
received this e-mail in error, please notify the sender immediately and then
delete it.  If you are not the intended recipient, you must not use, disclose
or distribute this e-mail without the author's permission.  We have taken
precautions to minimise the risk of transmitting software viruses, but we
advise you to carry out your own virus checks on any attachment to this e-mail.
We cannot accept liability for any loss or damage caused by software viruses.

View raw message