You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by ni...@apache.org on 2013/06/13 20:13:24 UTC
svn commit: r1492794 -
/poi/site/src/documentation/content/xdocs/resolutions/res001.xml
Author: nick
Date: Thu Jun 13 18:13:24 2013
New Revision: 1492794
URL: http://svn.apache.org/r1492794
Log:
Fix whitespace, and remove the @author part as it is no longer Apache best practice
Modified:
poi/site/src/documentation/content/xdocs/resolutions/res001.xml
Modified: poi/site/src/documentation/content/xdocs/resolutions/res001.xml
URL: http://svn.apache.org/viewvc/poi/site/src/documentation/content/xdocs/resolutions/res001.xml?rev=1492794&r1=1492793&r2=1492794&view=diff
==============================================================================
--- poi/site/src/documentation/content/xdocs/resolutions/res001.xml (original)
+++ poi/site/src/documentation/content/xdocs/resolutions/res001.xml Thu Jun 13 18:13:24 2013
@@ -30,49 +30,51 @@
<body>
<section><title>Resolution 001 - Minimal Coding Standards</title>
- <section><title>Majority Position</title>
- <p>
- As the POI project has grown the "styles" used have become more
- varied, some see this as a bad thing, but in reality it
- can be a good thing. Each can learn from the different
- styles by working with different code. That being said
- there are some universal "good quality" guidelines that
- must be adopted on a project of any proportions.
- </p>
- <p>
- Marc Johnson Authored the following resolution:
- </p>
- <p>
- On Tue, 2002-01-08 at 22:23, Marc Johnson wrote:
- Standards are wonderful; everyone should have a set.
- Here's what I propose for coding standards for POI WRT comments (should I
- feel the need, I'll post more of these little gems):
- </p>
- <ol>
- <li>
- All classes and interfaces MUST have, right at the
- beginning of the file, the Apache Software License
- 2.0 License Header. (see /legal/LICENSE).
- </li>
- <li>
- All classes and interfaces MUST include class javadoc. Conventionally,
- this goes after the package and imports, and before the start of the class
- or interface. The class javadoc MUST have at least one @author tag
- </li>
- <li>
- All methods that are accessible outside the class MUST have javadoc
- comments. In other words, if it isn't private, it MUST have javadoc
- comments. Simple getters can consist of a simple @return tag; simple setters
- can consist of a simple @param tag. Anything else requires some verbiage
- plus all the standard javadoc tags as appropriate. You MUST include @throws
- or @exception for any non-runtime exceptions, and you SHOULD document any
- runtime exceptions you expect to throw. @throws/@exception tags SHOULD
- include an explanation of why that exception would be thrown. If your method
- might return null, you MUST say so. An accompanying explanation of the
- circumstances for doing so would be nice.
- </li>
- </ol>
- </section>
+ <section><title>Majority Position</title>
+ <p>
+ As the POI project has grown the "styles" used have become more
+ varied, some see this as a bad thing, but in reality it
+ can be a good thing. Each can learn from the different
+ styles by working with different code. That being said
+ there are some universal "good quality" guidelines that
+ must be adopted on a project of any proportions.
+ </p>
+ <p>
+ Marc Johnson Authored the following resolution:
+ </p>
+ <p>
+ On Tue, 2002-01-08 at 22:23, Marc Johnson wrote:
+ Standards are wonderful; everyone should have a set.
+ Here's what I propose for coding standards for POI WRT comments (should I
+ feel the need, I'll post more of these little gems):
+ </p>
+ <ol>
+ <li>
+ All classes and interfaces MUST have, right at the
+ beginning of the file, the Apache Software License
+ 2.0 License Header. (see /legal/LICENSE).
+ </li>
+ <li>
+ All classes and interfaces MUST include class javadoc. Conventionally,
+ this goes after the package and imports, and before the start of the class
+ or interface.
+ <!-- No more author tags -->
+ <!-- The class javadoc MUST have at least one @author tag -->
+ </li>
+ <li>
+ All methods that are accessible outside the class MUST have javadoc
+ comments. In other words, if it isn't private, it MUST have javadoc
+ comments. Simple getters can consist of a simple @return tag; simple setters
+ can consist of a simple @param tag. Anything else requires some verbiage
+ plus all the standard javadoc tags as appropriate. You MUST include @throws
+ or @exception for any non-runtime exceptions, and you SHOULD document any
+ runtime exceptions you expect to throw. @throws/@exception tags SHOULD
+ include an explanation of why that exception would be thrown. If your method
+ might return null, you MUST say so. An accompanying explanation of the
+ circumstances for doing so would be nice.
+ </li>
+ </ol>
+ </section>
<section><title>Amendments (informal by extension and not by vote)</title>
<section><title>License</title>
<p>
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org