SEC: UNCLASSIFIED - [Opensource] for a clean source code

[McAuliffe, Robert]

I think that updating the Javadoc would be a *very* good idea.  I'm just a
basic user of Expresso, so you'd think that I would be able to use the
Javadoc to determine how I should use the objects (particularly DBObject).
However, in order to find out what exception was thrown in a particular
circumstance, I needed to look at the source code.  This information should
be in the Javadoc, even if its not in the throws clause.

(The actual thing I was looking for was which exception was thrown if a
record was not found on update, as opposed to if a problem occurred
contacting the database etc.)


Rob McAuliffe

PS I've only really had a fairly brief exposure to the Expresso code, and
only of DBObject et al. (We're only using the database facilities of
expresso)  But it would seem to me that some of the code (DBObject in
particular at 7000ish lines) needs some heavy refactoring.  What sort of
stuff is planned for this (or where can I find info on what is planned)?


		-----Original Message-----
		From:	Peter A. Pilgrim
[mailto:peterp at xenonsoft.demon.co.uk]
<mailto:[mailto:peterp at xenonsoft.demon.co.uk]> 
		Sent:	Thursday, 13 February 2003 14:56
		To:	opensource at jcorporate.com
<mailto:opensource at jcorporate.com> 
		Subject:	Re: [Opensource] for a clean source code

		Lirian Ostrovica wrote:
		> Hi all,
		> 
		> Just wanted to express a concern here.
		> It really bothers me to often face left over code
throughout the Expressos source
		> code.
		> In absence of  good or sufficient documentation, you turn
to the source code, and
		> when the source code is misleading
		> it is very bad : you waste your time, you waste the time
of the people who you ask
		> for clarifications, beginners get really confused and
frustrated till to the point
		> of giving up etc etc.
		>

		Lirian may you should compare with another open source
project e.g tomcat, struts
		or junit to really give a fair code review.

		In the new componentization package
com.jcorporate.expresso.kernel** has a little
		javadoc comments? There should be a rich set of javadoc for
the newest package.

		Some of the packages have a lack of javadoc or even comments
because Michael
		Nash was the sole developer at the beginning. May be this
should on the TODO
		list for Expresso 6.0!


		-- 
		Peter Pilgrim
		            __ _____ _____ _____
		           / //__  // ___// ___/   +  Serverside Java
		          / /___/ // /__ / /__     +  Struts
		         / // ___// ___// ___/     +  Expresso Committer
		      __/ // /__ / /__ / /__       +  Independent Contractor
		     /___//____//____//____/       +  Intrinsic Motivation
		On Line Resume
		    ||
		    \\===>  ``
http://www.xenonsoft.demon.co.uk/no-it-striker.html
<http://www.xenonsoft.demon.co.uk/no-it-striker.html>  ''

		_______________________________________________
		Opensource mailing list
		Opensource at jcorporate.com <mailto:Opensource at jcorporate.com>

		http://mail.jcorporate.com/mailman/listinfo/opensource
<http://mail.jcorporate.com/mailman/listinfo/opensource> 
		Archives: http://mail.jcorporate.com/pipermail/opensource/
<http://mail.jcorporate.com/pipermail/opensource/>