Skip to content

Developer Guidelines

hwbllmnn edited this page Apr 30, 2013 · 36 revisions

Source code formatting in eclipse

In case you're using the deegree maven plugin, your eclipse can be automatically configured to use the deegree formatter. See https://github.com/deegree/deegree-maven-plugin/wiki/EclipseMojo or https://github.com/deegree/deegree-maven-plugin/wiki/EclipseProjectLinkerMojo to see how that's done.

You can also import the formatter manually, download the https://raw.github.com/wiki/deegree/deegree3/formatter.xml .

File headers

I'd like to propose an adapted file header. Download https://raw.github.com/wiki/deegree/deegree3/codetemplates.xml for easy eclipse import (includes the class headers).

See it here:

/*----------------------------------------------------------------------------
 This file is part of deegree
 Copyright (C) 2001-2013 by:
 - Department of Geography, University of Bonn -
 and
 - lat/lon GmbH -
 and
 - Occam Labs UG (haftungsbeschränkt) -
 and others

 This library is free software; you can redistribute it and/or modify it under
 the terms of the GNU Lesser General Public License as published by the Free
 Software Foundation; either version 2.1 of the License, or (at your option)
 any later version.
 This library is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 details.
 You should have received a copy of the GNU Lesser General Public License
 along with this library; if not, write to the Free Software Foundation, Inc.,
 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

 Contact information:

 e-mail: info@deegree.org
 website: http://www.deegree.org/
----------------------------------------------------------------------------*/

Class headers

I propose the removal of the obsolete svn replacement tags for class headers.

Download https://raw.github.com/wiki/deegree/deegree3/codetemplates.xml for easy eclipse import (includes the file headers).

See an example here:

/**
 * TODO add class documentation here
 * 
 * @author <a href="mailto:schmitz@occamlabs.de">Andreas Schmitz</a>
 */

Clone this wiki locally