Mailing-List: contact geronimo-dev-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: geronimo-dev@incubator.apache.org
Message-ID: <87375DD3DB18D511AF8800508BDFACDC13393C2A@reacsmail.rea.gni>
From: "Raveendranath, Rohith (LNG - AUS)"
	 <Rohith.Raveendranath@LexisNexis.com.au>
To: "'geronimo-dev@incubator.apache.org'"
	 <geronimo-dev@incubator.apache.org>
Subject: RE: [PATCH] [JSR-88] JavaDoc
Date: Sat, 23 Aug 2003 15:07:32 +1000
MIME-Version: 1.0
Content-Type: text/plain;
	charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable

can't agree more ....

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

i feel this could help us have a better look at the application as and wh=
en
we write the docs ..=20

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

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

Rohith


-----Original Message-----
From: Jules Gosnell [mailto:jules@coredevelopers.net]
Sent: Friday, 22 August 2003 7:29 PM
To: geronimo-dev@incubator.apache.org
Subject: Re: [PATCH] [JSR-88] JavaDoc


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

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

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

Jules


Bill de h=D3ra wrote:

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

> lic policy with this.
>
> Bill de h=D3ra
>
>


--=20
/**********************************
=20* Jules Gosnell
=20* Partner
=20* Core Developers Network (Europe)
=20**********************************/

This e-mail is for the use of the intended recipient(s) only.  If you hav=
e
received this e-mail in error, please notify the sender immediately and t=
hen
delete it.  If you are not the intended recipient, you must not use, disc=
lose
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 viru=
ses.