avalon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Paul Hammant <Paul_Hamm...@yahoo.com>
Subject Re: javadoc - can I help?
Date Thu, 10 Jan 2002 15:17:02 GMT
John,

Feel free to supply Javadoc comments or anything.  A 'unitied diff' is 
the best way, just email them to this list.  

- Paul

>Just joined the list, just starting to look at the project. This is great
>stuff. My one complaint right now is the javadoc. It seems that most things
>I look up have the bare-bones (read "none") javadoc entries. For instance,
>today I was looking at the excaliber pool implementations to see what
>happens when I try to get something from a Pool where all resources are
>already taken up - does it block or does it return immediately with a null
>(or do either - right now I need the latter behavior)? But the javadoc for
>Pool's get() reads:
> get
> public Poolable get()
>             throws java.lang.Exception
> java.lang.Exception
>
>So what I'd be willing to take on, unless someone else is doing this, is a
>first pass at writing some real javadoc for some of this stuff, since I
>figure I will dig into the code anyway.
>
>I'm new to jakarta and avalon, so like I said I don't know the procedures,
>so if I am way off base. my apologies. Elsewise, is this an idea and, if so,
>how should I start?
>
>Whee.
>
>john
>
>-+-+-+-+-+-+-+-+-
>john guthrie
>american institutes for research
>jguthrie@air.org
>202-298-2716 
>
>--
>To unsubscribe, e-mail:   <mailto:avalon-dev-unsubscribe@jakarta.apache.org>
>For additional commands, e-mail: <mailto:avalon-dev-help@jakarta.apache.org>
>
>
>




--
To unsubscribe, e-mail:   <mailto:avalon-dev-unsubscribe@jakarta.apache.org>
For additional commands, e-mail: <mailto:avalon-dev-help@jakarta.apache.org>


Mime
View raw message