I forgot. Cleaning up the javadocs is ok and greatly appreciated.
john mcnally
Gary Lawrence Murphy wrote:
>
> Ok, the subject line is a leading question ;) but since I need to change
> these _anyway_, I wondered if others may be interested.
>
> I'd like to submit a patch against the Torque om templates to change
> the embedded comments to be more amiable to javadoc and CVS. I also
> found, from bitter first hand experience, that it is very useful to
> have the class name at the top of the comment block when you are hunting
> deleted inodes ;)
>
> The changes I propose would result in a template comment like the
> following for the top-level classes:
>
> /**
> * Class $table.javaName extends the $basePrefix$table.JavaName class
> * to isolate project extensions and convenience functions.
> *
> * <p>You should add additional methods to this class to meet the
> * application requirements. This class will only be generated as
> * long as it does not already exist in the output directory.</p>
> *
> * <p>Generated: $now</p>
> *
> * @author <a href="mailto:$email";>$author</a>
> * @copyright $copyright
> * @version $Id$
> */
>
> (obviously, $email, $author and $copyright will be unresolved)
>
> For the lower-level classes, the author tag can be hard-wired to a
> Torque contact address (the mailing list?) and the copyright assigned to
> the Torque authors (ASF?), both further re-inforcing the caution that
> these low-level classes should never be edited by hand.
>
> While I'm in there, I'd also like to clean up some of the other javadoc
> comments.
>
> Shall I submit the patch?
>
> --
> Gary Lawrence Murphy <[EMAIL PROTECTED]> TeleDynamics Communications Inc
> Business Innovations Through Open Source Systems: http://www.teledyn.com
> "Computers are useless. They can only give you answers."(Pablo Picasso)
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: [EMAIL PROTECTED]
> For additional commands, e-mail: [EMAIL PROTECTED]
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
