<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type">
</head>
<body bgcolor="#ffffff" text="#000000">
Brute force. Done!<br>
<br>
Joe Walker wrote:
<blockquote cite="mid5dd474260505091536609203e0@mail.gmail.com"
type="cite"><br>
I think it is a good idea.<br>
Cluttering up the JavaDoc isn't such a good idea, and it has always
worried me that the HTML markup needed reduced the force of the legal
message.<br>
Do you have a good way of doing it automatically?<br>
Joe<br>
<br>
<div><span class="gmail_quote">On 5/7/05, <b class="gmail_sendername">DM
Smith</b> <<a href="mailto:dmsmith555@yahoo.com">dmsmith555@yahoo.com</a>>
wrote:</span>
<blockquote class="gmail_quote"
style="border-left: 1px solid rgb(204, 204, 204); margin: 0pt 0pt 0pt 0.8ex; padding-left: 1ex;">Bet
that got your attention!<br>
<br>
Nothing radical, nothing to start a long thread;)<br>
<br>
I would like to suggest that we change where we put the license notice<br>
in the source.<br>
<br>
Right now the GPL license notice is in the type's javadoc. I would like
<br>
to recommend that we move it to be a file comment, preceding the package<br>
declaration. I don't know that this is a standard, but it is fairly<br>
typical of java code. Also, there is direct support for it in Eclipse<br>
(more on that below) and CheckStyle can be made to check that it is at<br>
the top and is unchanged.<br>
<br>
The difference is that it would not show up in the javadoc for each<br>
class. I do recommend that we add it to each package's javadoc
<br>
(package.html)<br>
<br>
The following settings in eclipse (using 3.1M6 for the example) will<br>
enable a package comment:<br>
Window->Preferences->Java->Code Style->Code
Templates->Comments->Files<br>
to set the package comment.
<br>
Window->Preferences->Java->Code Style->Code
Templates->Code->New Java<br>
Files to put it at the top of the file.<br>
Window->Preferences->Java->Code Style->Code
Templates->Comments->Types
<br>
to remove it from the class .<br>
<br>
For the first I recommend: (There is no change to the text other than<br>
formatting.)<br>
/**<br>
* Distribution License:<br>
* JSword is free software; you can redistribute it and/or modify it
under
<br>
* the terms of the GNU General Public License, version 2 as published by<br>
* the Free Software Foundation. This program is distributed in the hope<br>
* that it will be useful, but WITHOUT ANY WARRANTY; without even the
<br>
* implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE.<br>
* See the GNU General Public License for more details.<br>
*<br>
* The License is available on the internet at:<br>
* <a href="http://www.gnu.org/copyleft/gpl.html">
http://www.gnu.org/copyleft/gpl.html</a><br>
* or by writing to:<br>
* Free Software Foundation, Inc.<br>
* 59 Temple Place - Suite 330<br>
* Boston, MA 02111-1307, USA<br>
*<br>
* Copyright: ${year}<br>
* The copyright to this program is held by it's authors.
<br>
*<br>
* ID: $$ID$$<br>
*/<br>
<br>
For the second I recommend: (filecomment is the name of the variable set<br>
above)<br>
${filecomment}<br>
${package_declaration}<br>
<br>
${typecomment}<br>
${type_declaration}<br>
<br>
For the third I recommend: (replace my author string with yours)
<br>
/**<br>
*<br>
* @see gnu.gpl.License for license details.<br>
* The copyright to this program is held by it's authors.<br>
* @author DM Smith [ dmsmith555 at yahoo dot com]<br>
*/<br>
I would like to figure out how to modify ${user} or create my own
<br>
template variable, ${author}, to use with @author<br>
<br>
_______________________________________________<br>
jsword-devel mailing list<br>
<a href="mailto:jsword-devel@crosswire.org">jsword-devel@crosswire.org</a><br>
<a href="http://www.crosswire.org/mailman/listinfo/jsword-devel">http://www.crosswire.org/mailman/listinfo/jsword-devel</a><br>
</blockquote>
</div>
<br>
<pre wrap="">
<hr size="4" width="90%">
_______________________________________________
jsword-devel mailing list
<a class="moz-txt-link-abbreviated" href="mailto:jsword-devel@crosswire.org">jsword-devel@crosswire.org</a>
<a class="moz-txt-link-freetext" href="http://www.crosswire.org/mailman/listinfo/jsword-devel">http://www.crosswire.org/mailman/listinfo/jsword-devel</a>
</pre>
</blockquote>
</body>
</html>