You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-dev@james.apache.org by rd...@apache.org on 2009/05/14 18:19:36 UTC
svn commit: r774840 - /james/site/trunk/www/
Author: rdonkin
Date: Thu May 14 16:19:35 2009
New Revision: 774840
URL: http://svn.apache.org/viewvc?rev=774840&view=rev
Log:
Regenerated web site
Modified:
james/site/trunk/www/contribute.html
james/site/trunk/www/dependencies.html
james/site/trunk/www/dependency-convergence.html
james/site/trunk/www/download.html
james/site/trunk/www/guidelines.html
james/site/trunk/www/index.html
james/site/trunk/www/integration.html
james/site/trunk/www/issue-tracking.html
james/site/trunk/www/license.html
james/site/trunk/www/mail-lists.html
james/site/trunk/www/newsarchive.html
james/site/trunk/www/plugin-management.html
james/site/trunk/www/project-info.html
james/site/trunk/www/project-summary.html
james/site/trunk/www/source-repository.html
james/site/trunk/www/team-list.html
james/site/trunk/www/weare.html
Modified: james/site/trunk/www/contribute.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/contribute.html?rev=774840&r1=774839&r2=774840&view=diff
==============================================================================
--- james/site/trunk/www/contribute.html (original)
+++ james/site/trunk/www/contribute.html Thu May 14 16:19:35 2009
@@ -118,10 +118,6 @@
</li>
<li class="none">
- <a href="code-standards.html">Standards</a>
- </li>
-
- <li class="none">
<a href="license.html">License</a>
</li>
</ul>
@@ -259,6 +255,73 @@
happy to receive good documentation.
</p>
</div>
+
+ <a name="Coding Standards"></a><div class="section"><h2>Coding Standards</h2>
+
+ <p>
+ Submissions to the James project must follow the coding conventions
+ outlined in this document. James developers
+ are asked to follow coding conventions already present in the code.
+ (For example, if the existing code has the bracket on
+ the same line as the if statement, then all subsequent code
+ should also follow that convention.) Anything not
+ explicitly mentioned in this document should adhere to the
+ official
+ <a href="http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html">Sun
+ Java Coding Conventions</a>.
+ </p>
+
+ <p>
+ <strong>Developers who commit code that does not follow
+ the coding conventions outlined in this document will be
+ responsible for fixing their own code.</strong>
+ </p>
+
+ <p>
+ 1. Spaces between parentheses are optional. The preference is to exclude
+ extra spaces. Both of these conventions are acceptable:
+ </p>
+
+ <p>
+ <div class="source"><pre>
+
+ if (foo)
+
+ or
+
+ if ( foo )
+ </pre></div>
+ </p>
+
+ <p>
+ 2. Four spaces. <strong>NO tabs</strong>. Period. The James
+ mailing list receives commit messages that are almost impossible
+ to read if tabs are used.
+ </p>
+
+ <p>
+ In Emacs-speak, this translates to the following command:
+
+ (setq-default tab-width 4 indent-tabs-mode nil)
+ </p>
+
+ <p>
+ 3. Use Unix linefeeds for all .java source code files. Only platform-specific
+ files (e.g. .bat files for Windows) should contain non-Unix linefeeds.
+ </p>
+
+ <p>
+ 4. Javadoc <strong>must</strong> exist on all methods. Contributing
+ a missing javadoc for any method, class, variable, etc., will be GREATLY
+ appreciated as this will help to improve the James project.
+ </p>
+
+ <p>
+ 5. The standard Apache boilerplace <strong>MUST</strong> be placed
+ at the top of every file.
+ </p>
+
+ </div>
Modified: james/site/trunk/www/dependencies.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/dependencies.html?rev=774840&r1=774839&r2=774840&view=diff
==============================================================================
--- james/site/trunk/www/dependencies.html (original)
+++ james/site/trunk/www/dependencies.html Thu May 14 16:19:35 2009
@@ -115,10 +115,6 @@
</li>
<li class="none">
- <a href="code-standards.html">Standards</a>
- </li>
-
- <li class="none">
<a href="license.html">License</a>
</li>
</ul>
Modified: james/site/trunk/www/dependency-convergence.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/dependency-convergence.html?rev=774840&r1=774839&r2=774840&view=diff
==============================================================================
--- james/site/trunk/www/dependency-convergence.html (original)
+++ james/site/trunk/www/dependency-convergence.html Thu May 14 16:19:35 2009
@@ -115,10 +115,6 @@
</li>
<li class="none">
- <a href="code-standards.html">Standards</a>
- </li>
-
- <li class="none">
<a href="license.html">License</a>
</li>
</ul>
Modified: james/site/trunk/www/download.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/download.html?rev=774840&r1=774839&r2=774840&view=diff
==============================================================================
--- james/site/trunk/www/download.html (original)
+++ james/site/trunk/www/download.html Thu May 14 16:19:35 2009
@@ -118,10 +118,6 @@
</li>
<li class="none">
- <a href="code-standards.html">Standards</a>
- </li>
-
- <li class="none">
<a href="license.html">License</a>
</li>
</ul>
Modified: james/site/trunk/www/guidelines.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/guidelines.html?rev=774840&r1=774839&r2=774840&view=diff
==============================================================================
--- james/site/trunk/www/guidelines.html (original)
+++ james/site/trunk/www/guidelines.html Thu May 14 16:19:35 2009
@@ -118,10 +118,6 @@
</li>
<li class="none">
- <a href="code-standards.html">Standards</a>
- </li>
-
- <li class="none">
<a href="license.html">License</a>
</li>
</ul>
Modified: james/site/trunk/www/index.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/index.html?rev=774840&r1=774839&r2=774840&view=diff
==============================================================================
--- james/site/trunk/www/index.html (original)
+++ james/site/trunk/www/index.html Thu May 14 16:19:35 2009
@@ -118,10 +118,6 @@
</li>
<li class="none">
- <a href="code-standards.html">Standards</a>
- </li>
-
- <li class="none">
<a href="license.html">License</a>
</li>
</ul>
Modified: james/site/trunk/www/integration.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/integration.html?rev=774840&r1=774839&r2=774840&view=diff
==============================================================================
--- james/site/trunk/www/integration.html (original)
+++ james/site/trunk/www/integration.html Thu May 14 16:19:35 2009
@@ -115,10 +115,6 @@
</li>
<li class="none">
- <a href="code-standards.html">Standards</a>
- </li>
-
- <li class="none">
<a href="license.html">License</a>
</li>
</ul>
Modified: james/site/trunk/www/issue-tracking.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/issue-tracking.html?rev=774840&r1=774839&r2=774840&view=diff
==============================================================================
--- james/site/trunk/www/issue-tracking.html (original)
+++ james/site/trunk/www/issue-tracking.html Thu May 14 16:19:35 2009
@@ -115,10 +115,6 @@
</li>
<li class="none">
- <a href="code-standards.html">Standards</a>
- </li>
-
- <li class="none">
<a href="license.html">License</a>
</li>
</ul>
Modified: james/site/trunk/www/license.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/license.html?rev=774840&r1=774839&r2=774840&view=diff
==============================================================================
--- james/site/trunk/www/license.html (original)
+++ james/site/trunk/www/license.html Thu May 14 16:19:35 2009
@@ -118,10 +118,6 @@
</li>
<li class="none">
- <a href="code-standards.html">Standards</a>
- </li>
-
- <li class="none">
<strong>License</strong>
</li>
</ul>
Modified: james/site/trunk/www/mail-lists.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/mail-lists.html?rev=774840&r1=774839&r2=774840&view=diff
==============================================================================
--- james/site/trunk/www/mail-lists.html (original)
+++ james/site/trunk/www/mail-lists.html Thu May 14 16:19:35 2009
@@ -115,10 +115,6 @@
</li>
<li class="none">
- <a href="code-standards.html">Standards</a>
- </li>
-
- <li class="none">
<a href="license.html">License</a>
</li>
</ul>
Modified: james/site/trunk/www/newsarchive.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/newsarchive.html?rev=774840&r1=774839&r2=774840&view=diff
==============================================================================
--- james/site/trunk/www/newsarchive.html (original)
+++ james/site/trunk/www/newsarchive.html Thu May 14 16:19:35 2009
@@ -118,10 +118,6 @@
</li>
<li class="none">
- <a href="code-standards.html">Standards</a>
- </li>
-
- <li class="none">
<a href="license.html">License</a>
</li>
</ul>
Modified: james/site/trunk/www/plugin-management.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/plugin-management.html?rev=774840&r1=774839&r2=774840&view=diff
==============================================================================
--- james/site/trunk/www/plugin-management.html (original)
+++ james/site/trunk/www/plugin-management.html Thu May 14 16:19:35 2009
@@ -115,10 +115,6 @@
</li>
<li class="none">
- <a href="code-standards.html">Standards</a>
- </li>
-
- <li class="none">
<a href="license.html">License</a>
</li>
</ul>
Modified: james/site/trunk/www/project-info.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/project-info.html?rev=774840&r1=774839&r2=774840&view=diff
==============================================================================
--- james/site/trunk/www/project-info.html (original)
+++ james/site/trunk/www/project-info.html Thu May 14 16:19:35 2009
@@ -115,10 +115,6 @@
</li>
<li class="none">
- <a href="code-standards.html">Standards</a>
- </li>
-
- <li class="none">
<a href="license.html">License</a>
</li>
</ul>
Modified: james/site/trunk/www/project-summary.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/project-summary.html?rev=774840&r1=774839&r2=774840&view=diff
==============================================================================
--- james/site/trunk/www/project-summary.html (original)
+++ james/site/trunk/www/project-summary.html Thu May 14 16:19:35 2009
@@ -115,10 +115,6 @@
</li>
<li class="none">
- <a href="code-standards.html">Standards</a>
- </li>
-
- <li class="none">
<a href="license.html">License</a>
</li>
</ul>
Modified: james/site/trunk/www/source-repository.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/source-repository.html?rev=774840&r1=774839&r2=774840&view=diff
==============================================================================
--- james/site/trunk/www/source-repository.html (original)
+++ james/site/trunk/www/source-repository.html Thu May 14 16:19:35 2009
@@ -115,10 +115,6 @@
</li>
<li class="none">
- <a href="code-standards.html">Standards</a>
- </li>
-
- <li class="none">
<a href="license.html">License</a>
</li>
</ul>
Modified: james/site/trunk/www/team-list.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/team-list.html?rev=774840&r1=774839&r2=774840&view=diff
==============================================================================
--- james/site/trunk/www/team-list.html (original)
+++ james/site/trunk/www/team-list.html Thu May 14 16:19:35 2009
@@ -115,10 +115,6 @@
</li>
<li class="none">
- <a href="code-standards.html">Standards</a>
- </li>
-
- <li class="none">
<a href="license.html">License</a>
</li>
</ul>
Modified: james/site/trunk/www/weare.html
URL: http://svn.apache.org/viewvc/james/site/trunk/www/weare.html?rev=774840&r1=774839&r2=774840&view=diff
==============================================================================
--- james/site/trunk/www/weare.html (original)
+++ james/site/trunk/www/weare.html Thu May 14 16:19:35 2009
@@ -118,10 +118,6 @@
</li>
<li class="none">
- <a href="code-standards.html">Standards</a>
- </li>
-
- <li class="none">
<a href="license.html">License</a>
</li>
</ul>