Recent javadoc updates

[Simon Kitching <sk...@obsidium.com>]

Hi All,

Sorry for the flood of javadoc commits; this is some stuff I've had 
sitting around for a while.

For the changes to the api/impl classes, I've checked the JSP1.2 
javadoc, and what I've got is a bit different in flavour from the spec 
so I've committed it for you to look at. If you don't like it please 
tell me and I'll take it out again. However it's info that I painfully 
learned by studying the code, and would have found useful myself.

Of course any corrections are very welcome.

Regards,

Simon

Re: Recent javadoc updates

[Martin Marinschek <ma...@gmail.com>]

I'd say that for you, Mike,  it's that 1% or much lesser ;)

regards,

Martin

On 11/23/05, Mike Kienenberger <mk...@gmail.com> wrote:
> On 11/23/05, Sean Schofield <se...@gmail.com> wrote:
> > For every 1 mistake you make you will be adding 99 pieces of valuable
> > documentation and someone will eventually catch the 1 mistake!
>
> I agree.  In fact, this is my practice in answering emails too.  I
> answer them even when I'm unsure, because for that 1% (or greater)
> time I'm wrong, someone else will feel obligated to jump in and
> correct me :)
>


--

http://www.irian.at

Your JSF powerhouse -
JSF Consulting, Development and
Courses in English and German

Professional Support for Apache MyFaces

Re: Recent javadoc updates

[Mike Kienenberger <mk...@gmail.com>]

On 11/23/05, Sean Schofield <se...@gmail.com> wrote:
> For every 1 mistake you make you will be adding 99 pieces of valuable
> documentation and someone will eventually catch the 1 mistake!

I agree.  In fact, this is my practice in answering emails too.  I
answer them even when I'm unsure, because for that 1% (or greater)
time I'm wrong, someone else will feel obligated to jump in and
correct me :)

Re: Recent javadoc updates

[Sean Schofield <se...@gmail.com>]

Documentation is our single biggest weakness right now IMO (especially
the code documentation but javadoc is not far behind.)  So if you are
reasonably certain your docs are right don't hesitate to add them! 
For every 1 mistake you make you will be adding 99 pieces of valuable
documentation and someone will eventually catch the 1 mistake!

sean

On 11/22/05, Travis Reeder <tr...@gmail.com> wrote:
> Keep them coming, there is far too few comments in the code right now.
>  I'm sure some comments would have saved me many hours.
>
> Travis
>
> On 11/22/05, Simon Kitching <sk...@obsidium.com> wrote:
> > Hi All,
> >
> > Sorry for the flood of javadoc commits; this is some stuff I've had
> > sitting around for a while.
> >
> > For the changes to the api/impl classes, I've checked the JSP1.2
> > javadoc, and what I've got is a bit different in flavour from the spec
> > so I've committed it for you to look at. If you don't like it please
> > tell me and I'll take it out again. However it's info that I painfully
> > learned by studying the code, and would have found useful myself.
> >
> > Of course any corrections are very welcome.
> >
> > Regards,
> >
> > Simon
> >
>

Re: Recent javadoc updates

[Travis Reeder <tr...@gmail.com>]

Keep them coming, there is far too few comments in the code right now.
 I'm sure some comments would have saved me many hours.

Travis

On 11/22/05, Simon Kitching <sk...@obsidium.com> wrote:
> Hi All,
>
> Sorry for the flood of javadoc commits; this is some stuff I've had
> sitting around for a while.
>
> For the changes to the api/impl classes, I've checked the JSP1.2
> javadoc, and what I've got is a bit different in flavour from the spec
> so I've committed it for you to look at. If you don't like it please
> tell me and I'll take it out again. However it's info that I painfully
> learned by studying the code, and would have found useful myself.
>
> Of course any corrections are very welcome.
>
> Regards,
>
> Simon
>