From a280debe4e2b6a92bc29655258d1cb5a205e1ce4 Mon Sep 17 00:00:00 2001 From: "Andrew C. Oliver" Date: Sun, 3 Mar 2002 19:22:47 +0000 Subject: [PATCH] added resolutions git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@352140 13f79535-47bb-0310-9956-ffa450edef68 --- src/documentation/xdocs/book.xml | 1 + src/documentation/xdocs/resolutions/book.xml | 22 +++++ src/documentation/xdocs/resolutions/index.xml | 37 +++++++++ .../xdocs/resolutions/res001.xml | 81 +++++++++++++++++++ 4 files changed, 141 insertions(+) create mode 100644 src/documentation/xdocs/resolutions/book.xml create mode 100644 src/documentation/xdocs/resolutions/index.xml create mode 100644 src/documentation/xdocs/resolutions/res001.xml diff --git a/src/documentation/xdocs/book.xml b/src/documentation/xdocs/book.xml index d2d242382..3bfbb58f2 100644 --- a/src/documentation/xdocs/book.xml +++ b/src/documentation/xdocs/book.xml @@ -36,6 +36,7 @@ + diff --git a/src/documentation/xdocs/resolutions/book.xml b/src/documentation/xdocs/resolutions/book.xml new file mode 100644 index 000000000..c3f3d1a6a --- /dev/null +++ b/src/documentation/xdocs/resolutions/book.xml @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + + + + + diff --git a/src/documentation/xdocs/resolutions/index.xml b/src/documentation/xdocs/resolutions/index.xml new file mode 100644 index 000000000..b25df1491 --- /dev/null +++ b/src/documentation/xdocs/resolutions/index.xml @@ -0,0 +1,37 @@ + + + + +
+ Resolutons + About this section + + + +
+ + + +

+ Every project on Jakarta has resolutions that they vote on. + Decisions are made, etc. But what happens once those decisions + are made? They are archived in the mail list archive never to + be read again (once its not in the top 10 or so posts). So they + get discussed again and again. +

+

+ Rather than have that big waste of time, we have this section to + record important POI decisions. Once a decision is passed it + need only be linked to this page (either by creating a page for + it or by simply linking it to the archive messages). Wherever + possible a brief about how many votes for and against an maybe + some background should be posted. +

+

+ This section is intended mainly to reduce big waste of time + discussions from taking away from whats important...developing + POI! :-D +

+ + + diff --git a/src/documentation/xdocs/resolutions/res001.xml b/src/documentation/xdocs/resolutions/res001.xml new file mode 100644 index 000000000..51e371c2d --- /dev/null +++ b/src/documentation/xdocs/resolutions/res001.xml @@ -0,0 +1,81 @@ + + + + +
+ POI Resoluton + Resolution 001 - Minimal Coding Standards + + + +
+ + + + +

+ 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. +

+

+ 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 + feel the need, I'll post more of these little gems): +

+
    +
  1. + All classes and interfaces MUST have, right at the beginning, the POI + License (see poi/doc/LICENSE). +
    2. +
  2. + 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. +
  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 + circumstances for doing so would be nice. +
    4. +
+ + +

+ As opposed to the formerly used POI License which was + 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. +

+ + +

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

+ + +

+ Andy didn't feel like going through his mail and sucking + out the comments.. If there is anything you feel should + be added here do it yourself ;-). +

+ + + +