You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by bu...@apache.org on 2015/05/08 21:25:31 UTC
svn commit: r950636 - in /websites/staging/pdfbox/trunk/content: ./
codingconventions.html
Author: buildbot
Date: Fri May 8 19:25:30 2015
New Revision: 950636
Log:
Staging update by buildbot for pdfbox
Modified:
websites/staging/pdfbox/trunk/content/ (props changed)
websites/staging/pdfbox/trunk/content/codingconventions.html
Propchange: websites/staging/pdfbox/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri May 8 19:25:30 2015
@@ -1 +1 @@
-1678437
+1678438
Modified: websites/staging/pdfbox/trunk/content/codingconventions.html
==============================================================================
--- websites/staging/pdfbox/trunk/content/codingconventions.html (original)
+++ websites/staging/pdfbox/trunk/content/codingconventions.html Fri May 8 19:25:30 2015
@@ -146,9 +146,6 @@
<h3 id="formatting">Formatting</h3>
<ul>
<li>
-<p>Four spaces for indents, no tabs.</p>
-</li>
-<li>
<p>Braces go on their own line.</p>
</li>
<li>
@@ -170,6 +167,24 @@
<p>Prefer aligned wrapped parameter lists.</p>
</li>
</ul>
+<h3 id="whitespace">Whitespace</h3>
+<ul>
+<li>
+<p>Four spaces for indents, no tabs.</p>
+</li>
+<li>
+<p>Do not use spaces around parenthesis.</p>
+</li>
+<li>
+<p>Use spaces after control flow keywords.</p>
+</li>
+<li>
+<p>Prefer using blank lines to separate logical blocks of code, but do not be excessive.</p>
+</li>
+<li>
+<p>Prefer not following casts with a blank space.</p>
+</li>
+</ul>
<h3 id="structure">Structure</h3>
<ul>
<li>
@@ -186,28 +201,22 @@ Constructors<br />
Methods </p>
</li>
</ul>
-<h3 id="whitespace">Whitespace</h3>
+<h3 id="javadoc">JavaDoc</h3>
<ul>
<li>
-<p>Do not use spaces around parenthesis.</p>
-</li>
-<li>
-<p>Use spaces after control flow keywords.</p>
+<p>Public and protected methods and fields must have JavaDoc.</p>
</li>
<li>
-<p>Prefer using blank lines to separate logical blocks of code, but do not be excessive.</p>
+<p>Don't use <code>@version</code> tags.</p>
</li>
<li>
-<p>Prefer not following casts with a blank space.</p>
+<p>Don't use <code>@since</code> tags.</p>
</li>
-</ul>
-<h3 id="javadoc">JavaDoc</h3>
-<ul>
<li>
-<p>Public and protected methods and fields must have JavaDoc.</p>
+<p>Don't include your e-mail address in <code>@author</code> tags.</p>
</li>
<li>
-<p>Don't include @version tags or your e-mail address in JavaDoc.</p>
+<p>You may omit <code>@return</code> tags for getters as long as you include a summary which begins with the word "Returns".</p>
</li>
<li>
<p>Private methods do not require JavaDoc but may have partial JavaDoc if it adds valuable information.</p>