You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by Gary Lawrence Murphy <ga...@canada.com> on 2001/06/25 17:11:12 UTC
How fond are you of the Torque templates?
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 <ga...@teledyn.com> 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: turbine-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: turbine-dev-help@jakarta.apache.org
Re: How fond are you of the Torque templates?
Posted by John McNally <jm...@collab.net>.
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 <ga...@teledyn.com> 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: turbine-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: turbine-dev-help@jakarta.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: turbine-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: turbine-dev-help@jakarta.apache.org
Re: How fond are you of the Torque templates?
Posted by Gary Lawrence Murphy <ga...@canada.com>.
FTR: I'll probably wait on this until I can upgrade to 2.2
--
Gary Lawrence Murphy <ga...@teledyn.com> 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: turbine-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: turbine-dev-help@jakarta.apache.org
Re: How fond are you of the Torque templates?
Posted by Gary Lawrence Murphy <ga...@canada.com>.
>>>>> "J" == John McNally <jm...@collab.net> writes:
J> The author, email, etc. values can be put into build.properties
Any prefs for the names?
J> do not assign copyright of any of the generated code to ASF.
J> ASF does not own the copyright on output of Torque. I am not
J> sure it is legally possible to claim copyright ownership on the
J> output, but I do not think we should do so, regardless.
Point taken; it was just a thought, but you're probably right, there's
no basis to take ownership of the files. I was only trying to
re-inforce that the generated files should be considered sacred.
--
Gary Lawrence Murphy <ga...@teledyn.com> 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: turbine-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: turbine-dev-help@jakarta.apache.org
Re: How fond are you of the Torque templates?
Posted by John McNally <jm...@collab.net>.
The author, email, etc. values can be put into build.properties so that
they will be filled in. For the Base* classes I have no problem listing
an author tag that says something like "code generation by Torque" or
something like that. But do not assign copyright of any of the
generated code to ASF. ASF does not own the copyright on output of
Torque. I am not sure it is legally possible to claim copyright
ownership on the output, but I do not think we should do so, regardless.
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 <ga...@teledyn.com> 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: turbine-dev-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: turbine-dev-help@jakarta.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: turbine-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: turbine-dev-help@jakarta.apache.org