Show guidelines.html syntax highlighted
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta name="copyright" content="Copyright (c) Wolfgang Möstl 2006-2007. This page is made available under the GNU public license." >
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<meta name="DESCRIPTION" content="PovClipse online help">
<meta name="AUTHOR" content="Wolfgang Möstl">
<meta name="KEYWORDS" content="PovClipse,Documentation,Development,Guidelines">
<meta http-equiv="CONTENT-LANGUAGE" content="en">
<meta name="ROBOTS" content=" index,follow ">
<meta name="REVISIT-AFTER" content="10 DAYS">
<meta http-equiv="EXPIRES" content="86400">
<title>PovClipse: Project documentation</title>
<link rel="stylesheet" type="text/css" href="../style/docs.css">
</head>
<body>
<h1>Development guidelines</h1>
<p>
The following contains the development guidelines for this project.
</p>
<p class="note">
Please make sure you follow these guidelines!
</p>
<h2>Code GPL license notice</h2>
<p class="note">
Each and every class has to contain the GPL license at the very top,
just before the <code>package</code> declaration!
</p>
<pre>/*
* PovClipse - Eclipse plugin for editing and rendering Povray scene files.
* Copyright (C) 2006-2007 Wolfgang Moestl wmoestl@web.de
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/</pre>
</p>
<p class="note">
Please import the Eclipse template <code>Project_Documentation/templates/template_new_Java_files.xml</code>:<br>
<b>Window => Preferences => Java => Code Style => Code Templates => Import...</b>
</p>
<h2>Copyright</h2>
<p>
Please note that if you contribute code to this project
you do not have any copyright on it! By contributing you:
<ul>
<li><p class="error">hand over the full copyright to the project</p></li>
<li><p class="error">guarantee that you have either written the code yourself or
copied open source code, but you did <b>***NOT***</b> violated
somebody’s copyrights!!!</p></li>
</ul>
</p>
<h2>Code documentation</h2>
<h3>Java doc</h3>
<p>
All <code><b>public</b></code> and <code><b>protected</b></code>
methods have to be documented using the JavaDoc standard.
</p>
<p>
<code><b>private</b></code> methods have to be documented using JavaDoc
if:</p>
<ul>
<li>they are complex</li>
<li>have many input parameter</li>
<li>the method name does not clearly indicate what the methods purpose</li>
</ul>
<h3>Code comments</h3>
<p>
Please make heavy use of code comments!
If the code does something non-obvious please comment it!
</p>
<h2>Code formatting</h2>
<p>
Please make sure you use a similar code formatting than the
one already used.
</p>
<p class="note">
If a source is already checked into SVN please do <b>***NOT***</b>
use the Eclipse code formatting function anymore! If you do so it is
nearly impossible to use the SVN code comparison to find out
the changes!
</p>
<h2>End-user documentation</h2>
<p class="note">Each developer is responsible for maintaining the end-user
documentation for the features written by him/her!
</p>
<p>
If you have written a new feature you are the one writing the end-user
documentation for it.<br>
If you have changed an existing feature you are the one resopnsible for
updating the end-user documentation in order to reflect the changes!
</p>
<p class="note">Please read the project document on
<a href="../documentation/documentation.html">documentation</a>!</p>
</body>
<h2>Internationalization</h2>
<p class="note">Please read the document on
<a href="../translation/translation.html">Internationalization</a> for
information on key naming standards and similar issues!
</p>
</html>
See more files for this project here