moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Fixed a spelling mistake and added a small bit about jokes.

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@352398 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Glen Stampoultzis 2002-04-12 11:13:26 +00:00
parent c5278e4d7e
commit a96c48fd09
1 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
src/documentation/xdocs/resolutions/res001.xml
View File

@ -6,7 +6,7 @@
<title>POI Resoluton</title> <title>POI Resoluton</title>
<subtitle>Resolution 001 - Minimal Coding Standards</subtitle> <subtitle>Resolution 001 - Minimal Coding Standards</subtitle>
<authors> <authors>
<person name="Andrew C. Oliver" email="acoliver@apache.org"/> <person name="Andrew C. Oliver" email="acoliver@apache.org"/>
</authors> </authors>
</header> </header>
@ -20,36 +20,36 @@
styles by working with different code. That being said styles by working with different code. That being said
there are some universal "good quality" guidelines that there are some universal "good quality" guidelines that
must be adopted on a project of any proportions. must be adopted on a project of any proportions.
</p> </p>
<p> <p>
Marc Johnson Authored the following resolution: Marc Johnson Authored the following resolution:
</p> </p>
<p> <p>
On Tue, 2002-01-08 at 22:23, Marc Johnson wrote: On Tue, 2002-01-08 at 22:23, Marc Johnson wrote:
Standards are wonderful; everyone should have a set. 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): feel the need, I'll post more of these little gems):
</p> </p>
<ol> <ol>
<li> <li>
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). License (see poi/doc/LICENSE).
</li> </li>
<li> <li>
All classes and interfaces MUST include class javadoc. Conventionally, All classes and interfaces MUST include class javadoc. Conventionally,
this goes after the package and imports, and before the start of the class 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 or interface. The class javadoc MUST have at least one @author tag
</li> </li>
<li> <li>
All methods that are accessible outside the class MUST have javadoc 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. In other words, if it isn't private, it MUST have javadoc
comments. Simple getters can consist of a simple @return tag; simple setters comments. Simple getters can consist of a simple @return tag; simple setters
can consist of a simple @param tag. Anything else requires some verbiage can consist of a simple @param tag. Anything else requires some verbiage
plus all the standard javadoc tags as appropriate. You MUST include @throws plus all the standard javadoc tags as appropriate. You MUST include @throws
or @exception for any non-runtime exceptions, and you SHOULD document any or @exception for any non-runtime exceptions, and you SHOULD document any
runtime exceptions you expect to throw. @throws/@exception tags SHOULD runtime exceptions you expect to throw. @throws/@exception tags SHOULD
include an explanation of why that exception would be thrown. If your method 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 might return null, you MUST say so. An accompanying explanation of the
circumstances for doing so would be nice. circumstances for doing so would be nice.
</li> </li>
</ol> </ol>
@ -58,24 +58,24 @@
<section title="License"> <section title="License">
<p> <p>
As opposed to the formerly used POI License which was 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 Jakarta, use the APL 1.1 for the header. Currently, the
Apache Software Foundation requires us to use the full Apache Software Foundation requires us to use the full
long version. long version.
</p> </p>
</section> </section>
<section title="2 cents"> <section title="2 cents">
<p> <p>
Tip: No laughing allow in conversations regarding coding Tip: No laughing or joking allowed in conversations regarding coding
standards. standards.
Any mail on coding standards will be treated very seriously, Any mail on coding standards will be treated very seriously,
and sent here with a RTFM. and sent here with a RTFM.
</p> </p>
</section> </section>
</section> </section>
<section title="Dissent"> <section title="Dissent">
<p> <p>
The motion was passed unanimously with no negative or The motion was passed unanimously with no negative or
positive votes. positive votes.
</p> </p>
</section> </section>