iBatis 3.0 Javadoc?

[cowwoc <co...@bbs.darktech.org>]

Hi,

     I noticed that iBatis 3.0 is missing a lot of Javadoc comments, for 
example in the SqlSession class. The user manual talks about methods 
throwing exceptions yet there is no indication of what or when 
exceptions are thrown for most methods. Do you plan on fixing this prior 
to going GA?

Thanks,
Gili

---------------------------------------------------------------------
To unsubscribe, e-mail: user-java-unsubscribe@ibatis.apache.org
For additional commands, e-mail: user-java-help@ibatis.apache.org

Re: iBatis 3.0 Javadoc?

[Clinton Begin <cl...@gmail.com>]

PS:  When it comes to exceptions and iBATIS, you should always use:

try {
} finally {
}

And let the unchecked exception bubble to the top.  iBATIS only throws
unchecked exceptions.  If a SQLException was thrown and you want to read the
code for some reason, the original exception will always be in the exception
chain, but you'll have to catch Exception and follow the nested exception
chain.

Clinton


On Mon, Apr 5, 2010 at 2:50 PM, Clinton Begin <cl...@gmail.com>wrote:

> I don't, because I don't consider it a problem.  It's a personal opinion of
> mine that I much prefer proper documentation like the User Guide to source
> generated docs.  I've never read a decent JavaDoc outside of the JDK itself,
> and therefore I don't depend on them.  That's just me though.  In the past,
> javadocs have been contributed by the community.
>
> Cheers,
> Clinton
>
>
> On Mon, Apr 5, 2010 at 9:59 AM, cowwoc <co...@bbs.darktech.org> wrote:
>
>> Hi,
>>
>>    I noticed that iBatis 3.0 is missing a lot of Javadoc comments, for
>> example in the SqlSession class. The user manual talks about methods
>> throwing exceptions yet there is no indication of what or when exceptions
>> are thrown for most methods. Do you plan on fixing this prior to going GA?
>>
>> Thanks,
>> Gili
>>
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: user-java-unsubscribe@ibatis.apache.org
>> For additional commands, e-mail: user-java-help@ibatis.apache.org
>>
>>
>

Re: iBatis 3.0 Javadoc?

[Clinton Begin <cl...@gmail.com>]

I don't, because I don't consider it a problem.  It's a personal opinion of
mine that I much prefer proper documentation like the User Guide to source
generated docs.  I've never read a decent JavaDoc outside of the JDK itself,
and therefore I don't depend on them.  That's just me though.  In the past,
javadocs have been contributed by the community.

Cheers,
Clinton

On Mon, Apr 5, 2010 at 9:59 AM, cowwoc <co...@bbs.darktech.org> wrote:

> Hi,
>
>    I noticed that iBatis 3.0 is missing a lot of Javadoc comments, for
> example in the SqlSession class. The user manual talks about methods
> throwing exceptions yet there is no indication of what or when exceptions
> are thrown for most methods. Do you plan on fixing this prior to going GA?
>
> Thanks,
> Gili
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: user-java-unsubscribe@ibatis.apache.org
> For additional commands, e-mail: user-java-help@ibatis.apache.org
>
>