diff options
| author | Glen Stampoultzis <glens@apache.org> | 2003-04-24 00:53:41 +0000 |
|---|---|---|
| committer | Glen Stampoultzis <glens@apache.org> | 2003-04-24 00:53:41 +0000 |
| commit | 2d641e1f74a3118502974885e5f6577c2758d8a3 (patch) | |
| tree | 7e3eabf25a0b09b509e0a98ef18183190d81c37b /src/documentation/content/xdocs/resolutions | |
| parent | 3f0a48aa9cafdef785eaecf7f7ee369d58441eb5 (diff) | |
| download | poi-2d641e1f74a3118502974885e5f6577c2758d8a3.tar.gz poi-2d641e1f74a3118502974885e5f6577c2758d8a3.zip | |
Merged from BUILD_BRANCH. Note: There is one problem. The HDF testcases are failing for me which prevents the full build from running. Committers, please feel free to tweak the build on your own now.
git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@353067 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/documentation/content/xdocs/resolutions')
| -rw-r--r-- | src/documentation/content/xdocs/resolutions/book.xml | 22 | ||||
| -rw-r--r-- | src/documentation/content/xdocs/resolutions/index.xml | 37 | ||||
| -rw-r--r-- | src/documentation/content/xdocs/resolutions/res001.xml | 91 |
3 files changed, 150 insertions, 0 deletions
diff --git a/src/documentation/content/xdocs/resolutions/book.xml b/src/documentation/content/xdocs/resolutions/book.xml new file mode 100644 index 0000000000..c3f3d1a6aa --- /dev/null +++ b/src/documentation/content/xdocs/resolutions/book.xml @@ -0,0 +1,22 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//APACHE//DTD Cocoon Documentation Book V1.0//EN" "../dtd/book-cocoon-v10.dtd"> + +<book software="Poi Project" + title="Resolutions" + copyright="@year@ Poi Project"> + + <menu label="Navigation"> + <menu-item label="Main" href="../index.html"/> + </menu> + + <menu label="About"> + <menu-item label="About" href="index.html"/> + </menu> + + <menu label="Resolutions"> + <menu-item label="Coding Standards" href="res001.html"/> + </menu> + +</book> + + diff --git a/src/documentation/content/xdocs/resolutions/index.xml b/src/documentation/content/xdocs/resolutions/index.xml new file mode 100644 index 0000000000..24be4da1d6 --- /dev/null +++ b/src/documentation/content/xdocs/resolutions/index.xml @@ -0,0 +1,37 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "../dtd/document-v11.dtd"> + +<document> + <header> + <title>Resolutions</title> + <subtitle>About this section</subtitle> + <authors> + <person name="Andrew C. Oliver" email="acoliver@apache.org"/> + </authors> + </header> + + <body> + <section><title>About Resolutions</title> + <p> + 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. + </p> + <p> + 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. + </p> + <p> + This section is intended mainly to reduce big waste of time + discussions from taking away from whats important...developing + POI! :-D + </p> + </section> + </body> +</document> diff --git a/src/documentation/content/xdocs/resolutions/res001.xml b/src/documentation/content/xdocs/resolutions/res001.xml new file mode 100644 index 0000000000..b86d1658ed --- /dev/null +++ b/src/documentation/content/xdocs/resolutions/res001.xml @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "../dtd/document-v11.dtd"> + +<document> + <header> + <title>POI Resoluton</title> + <subtitle>Resolution 001 - Minimal Coding Standards</subtitle> + <authors> + <person name="Andrew C. Oliver" email="acoliver@apache.org"/> + </authors> + </header> + + <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, the POI + License (see poi/doc/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>Amendments (informal by extension and not by vote)</title> + <section><title>License</title> + <p> + 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. + </p> + </section> + <section><title>2 cents</title> + <p> + 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. + </p> + </section> + </section> + <section><title>Dissent</title> + <p> + The motion was passed unanimously with no negative or + neutral votes. + </p> + </section> + <section><title>Comments</title> + <p> + 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 ;-). + </p> + </section> + </section> + </body> +</document> |