Re: [Geotools-devel] Jalopy

[Cameron S. <csh...@bi...>]

On Saturday 26 Apr 2003 6:00 pm, Martin Desruisseaux wrote:
> > Also, I've created a Jalopy configuration file which contains pretty
> > printing information (including LGPL headers) which is referenced fro=
m:
> > http://geotools.org/gt2docs/developersguide.html#jalopy
>
> Thinking again about it, I realize that not all source files will have
> exactly the same LGPL header. Because:
>
> 1) Some classes has more than one owner. For example some classes was
>     written as part of my work while I was working at Fisheries and
>     Oceans Canada. While I'm fine with adding "Copyright (c) 2003
>     Geotools Project Management Committee (PMC)" everywhere, I can't
>     remove "Copyright (c) 1999 P=EAches et Oc=E9ans Canada". I don't wa=
nt
>     to remove "Copyright (c) 2001 Institut de Recherche pour le
>     D=E9veloppement" neither for the same reason.

If your code should have 2 or more licences covering it, then you should =
do=20
the following:

/*
 * Geotools2 LGPL header.
 * Bla, bla, bla.
 */

/*
 * Geotools license 2 (related to some other project.
 */

package org.geotools.foo.bar;
=2E..


> What are
> the changes that you made?

I couldn't remember what I had changed, and found it easier to start with=
 the=20
Sun Coding Conventions and then document the changes.
I've documented them here:
geotools.org/gt2docs/developersguide.html#jalopy

----------

On Saturday 26 Apr 2003 7:26 pm, Artur Hefczyc wrote:
> I don't know if you have changed config file during last weeks but bell=
ow
> I will present some of them:
> 1. Some sources became not compilable because Jalopy included
>     String "DOCUMENT ME!" with out before public static final
>     variables (contants) without comment characters.

Yes, I forced all comments to be added in the javadocs.  We can un-tick t=
his=20
if it is a problem.

> 2. Some places are formated not very well. i. e.:
>     I had:
>
>     public TableRow(RowField[] fieldsArr, HashMap fieldsMap) {
>
>     And got instead:
>
>     public TableRow(
>         RowField[] fieldsArr,
>         HashMap fieldsMap
>     ) {
>
>     Maybe it depends on particular preference but I prefer first.

I find the second more readable, but the first is in line with Sun Coding=
=20
Convention.  So I've created a new Jalopy configuration using option 1.

>     Or maybe second one is more readable indeed...
>
>     And one question: If all of GeoTools developers or almost all of
> GeoTools
>     developets prefer 2 spaces indenting, why to use 4?

I prefer 4 spaces because I think 4 spaces is more common.  However I can=
 be=20
convinced otherwise.  We can vote on it at the next IRC if you like.



--=20
Cameron Shorter              http://shorter.net/cameron
Open Source Developer        http://mapbuilder.sourceforge.net
                             http://geotools.sourceforge.net
Senior Software Engineer     http://www.adi-limited.com/