From a96c48fd09242642b6f883a836ddc67ccdf0935b Mon Sep 17 00:00:00 2001 From: Glen Stampoultzis Date: Fri, 12 Apr 2002 11:13:26 +0000 Subject: [PATCH] Fixed a spelling mistake and added a small bit about jokes. git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@352398 13f79535-47bb-0310-9956-ffa450edef68 --- .../xdocs/resolutions/res001.xml | 42 +++++++++---------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/src/documentation/xdocs/resolutions/res001.xml b/src/documentation/xdocs/resolutions/res001.xml index af812be4d..1e6e6306c 100644 --- a/src/documentation/xdocs/resolutions/res001.xml +++ b/src/documentation/xdocs/resolutions/res001.xml @@ -6,7 +6,7 @@ POI Resoluton Resolution 001 - Minimal Coding Standards - + @@ -20,36 +20,36 @@ 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. -

+

Marc Johnson Authored the following resolution:

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 + 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):

  1. - All classes and interfaces MUST have, right at the beginning, the POI + All classes and interfaces MUST have, right at the beginning, the POI License (see poi/doc/LICENSE).
  2. - All classes and interfaces MUST include class javadoc. Conventionally, - this goes after the package and imports, and before the start of the class + 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
  3. - 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 + 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.
@@ -58,24 +58,24 @@

As opposed to the formerly used POI License which was - based on the Apache Public License, now that POI is part of + based on the Apache Public License, now that POI is part of Jakarta, use the APL 1.1 for the header. Currently, the Apache Software Foundation requires us to use the full long version.

-
-
+
+

- Tip: No laughing allow in conversations regarding coding + Tip: No laughing or joking allowed in conversations regarding coding standards. Any mail on coding standards will be treated very seriously, and sent here with a RTFM.

-
+

- The motion was passed unanimously with no negative or + The motion was passed unanimously with no negative or positive votes.