-
Notifications
You must be signed in to change notification settings - Fork 1
Developer Guidelines
Not all information has been transferred from the old wiki yet. Please see:
- [Coding Guidelines (partially outdated)] (https://wiki.deegree.org/deegreeWiki/deegree3/CodingPractices)
- [Contributor guidelines (partially outdated)] (http://wiki.deegree.org/deegreeWiki/deegreeCommitterGuidelines)
- Test Practices
Contributors should use the official conventions for formatting source code. You can download the offical deegree formatter settings for Eclipse here: https://raw.github.com/wiki/deegree/deegree3/formatter.xml
Note that you can automatically apply the formatter settings to your Eclipe workspace, by using the deegree maven plugin. See https://github.com/deegree/deegree-maven-plugin/wiki/EclipseMojo or https://github.com/deegree/deegree-maven-plugin/wiki/EclipseProjectLinkerMojo.
This is the header to use for new java files. Download https://raw.github.com/wiki/deegree/deegree3/codetemplates.xml for easy Eclipse import (includes 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: [email protected]
website: http://www.deegree.org/
----------------------------------------------------------------------------*/This is the template to be used for class javadocs.
Download https://raw.github.com/wiki/deegree/deegree3/codetemplates.xml for easy eclipse import (includes the file headers).
See an example here:
/**
* This class is responsible for these things.
*
* @author <a href="mailto:[email protected]">Andreas Schmitz</a>
*
* @since 3.3
*/TBD