Menu
▾
▴
[MO-java-dev] CVS: mockobjects-java/doc/html coding_conventions.html,1.2,1.3 release_process.html,1.1,1.2 stylesheet.css,1.1,1.2 todo.html,1.2,1.3
|
From: Jeff M. <cus...@us...> - 2002-09-02 11:35:11
|
Update of /cvsroot/mockobjects/mockobjects-java/doc/html
In directory usw-pr-cvs1:/tmp/cvs-serv22179/html
Modified Files:
coding_conventions.html release_process.html stylesheet.css
todo.html
Log Message:
More tidy ups
Index: coding_conventions.html
===================================================================
RCS file: /cvsroot/mockobjects/mockobjects-java/doc/html/coding_conventions.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- coding_conventions.html 2 Sep 2002 10:26:25 -0000 1.2
+++ coding_conventions.html 2 Sep 2002 11:35:07 -0000 1.3
@@ -17,8 +17,6 @@
<h2>Mock Objects specific coding conventions</h2>
-<ol>
-<li>
<h3>Brackets</h3>
<p>For class and method declaration, brackets should begin on the <b>same</b> line. Example:</p>
<pre>
@@ -58,9 +56,7 @@
// some code
}
</pre>
-</li>
-<li>
<h3>Blank Spaces</h3>
<p>
keywords followed by a parenthesis should be separated by a space. Example :
@@ -84,133 +80,30 @@
printSize("size is " + foo + "\n");
</pre>
-</li>
-<li>
<h3>Indentations</h3>
<p><b>4 spaces. NO tabs</b>. Period. We understand that a lot of you like to use tabs, but the fact of the matter is that in a distributed development environment, when the cvs commit messages get sent to a mailing list, they are almost impossible to read if you use tabs.</p>
- <div class="c11">
- <table cellpadding="2" cellspacing="0"
- border="0" width="99%">
- <tr>
- <td bgcolor="#525D76" class="c12">
- <b>4. Comments</b></td>
- </tr>
-
- <tr>
- <td>
- <span class="c8"><br>
- </span>
-
- <p class="c9">Javadoc SHOULD exist
- on all your class members (methods
- + class variables), including the
- private ones. Also, if you are
- working on existing code and there
- currently isn't a javadoc for that
- method/class/variable or whatever,
- then you should contribute and add
- it. This will improve the project
- as a whole.</p>
-
- <p class="c9">Also add code
- comments when you think it's
- necessary (like assumptions),
- especially when the code is not
- obvious.</p>
- </td>
- </tr>
- </table>
- </div>
- <span class="c8"><br>
- </span>
-
- <div class="c11">
- <table cellpadding="2" cellspacing="0"
- border="0" width="99%">
- <tr>
- <td bgcolor="#525D76" class="c12">
- <b>5. License</b></td>
- </tr>
-
- <tr>
- <td>
- <span class="c8"><br>
- </span>
-
- <p class="c9">The Jakarta
- Apache/Cactus License MUST be
- placed at the top of each and every
- file.</p>
- </td>
- </tr>
- </table>
- </div>
- <span class="c8"><br>
- </span>
-
- <div class="c11">
- <table cellpadding="2" cellspacing="0"
- border="0" width="99%">
- <tr>
- <td bgcolor="#525D76" class="c12">
- <b>6. Author references</b></td>
- </tr>
-
- <tr>
- <td>
- <span class="c8"><br>
- </span>
-
- <p class="c9">If you contribute to
- a file (code or documentation), add
- yourself to the top of the file
- (below the existing authors). For
- java files the preferred Javadoc
- format is:</p>
-
- <div class="c13">
- <table cellpadding="2"
- cellspacing="2" border="1">
- <tr>
- <td>
+<h3>Comments</h3>
+<p>Javadoc SHOULD exist on all your class members (methods + class variables), including the private ones. Also, if you are working on existing code and there currently isn't a javadoc for that method/class/variable or whatever, then you should contribute and add it. This will improve the project as a whole.</p>
+
+<p>Also add code comments when you think it's necessary (like assumptions), especially when the code is not obvious.</p>
+
+<h3>License</h3>
+<p>The Jakarta Apache/Cactus License MUST be placed at the top of each and every file.</p>
+
+<h3>Author references</h3>
+
+<p>If you contribute to a file (code or documentation), add yourself to the top of the file (below the existing authors). For java files the preferred Javadoc format is:</p>
+
<pre>
@author <a href="mailto:us...@do...">John Doe</a>
</pre>
- </td>
- </tr>
- </table>
- </div>
- </td>
- </tr>
- </table>
- </div>
- <span class="c8"><br>
- </span>
-
- <div class="c11">
- <table cellpadding="2" cellspacing="0"
- border="0" width="99%">
- <tr>
- <td bgcolor="#525D76" class="c12">
- <b>7. Class variables</b></td>
- </tr>
-
- <tr>
- <td>
- <span class="c8"><br>
- </span>
-
- <p class="c9">Class variables
- should be prefixed with <b>my</b>.
- Example :</p>
-
- <div class="c13">
- <table cellpadding="2"
- cellspacing="2" border="1">
- <tr>
- <td>
+
+<h3>Class variables</h3>
+
+<p>Class variables should be prefixed with <b>my</b>. Example :</p>
+
<pre>
public class SomeClass {
private String myString;
@@ -220,141 +113,25 @@
}
}
</pre>
- </td>
- </tr>
- </table>
- </div>
- </td>
- </tr>
- </table>
- </div>
- <span class="c8"><br>
- </span>
-
- <div class="c11">
- <table cellpadding="2" cellspacing="0"
- border="0" width="99%">
- <tr>
- <td bgcolor="#525D76" class="c12">
- <b>8. Parameter names</b></td>
- </tr>
-
- <tr>
- <td>
- <span class="c8"><br>
- </span>
-
- <p class="c9">Method parameters
- should be prefixed by "<code class=
- "c14">a</code>" (for
- differentiating them from inner
- variables). For example :</p>
-
- <div class="c13">
- <table cellpadding="2"
- cellspacing="2" border="1">
- <tr>
- <td>
+
+<h3>Parameter names</h3>
+
+<p>Method parameters should be prefixed by "<code>a</code>" (for differentiating them from inner variables). For example :</p>
+
<pre>
public void someMethod(String aClassName) {
String className; // inner variable
}
</pre>
- </td>
- </tr>
- </table>
- </div>
- </td>
- </tr>
- </table>
- </div>
- <span class="c8"><br>
- </span>
-
- <div class="c11">
- <table cellpadding="2" cellspacing="0"
- border="0" width="99%">
- <tr>
- <td bgcolor="#525D76" class="c12">
- <b>9. Line length</b></td>
- </tr>
-
- <tr>
- <td>
- <span class="c8"><br>
- </span>
-
- <p class="c9">Avoid lines longer
- than 78 characters for Code,
- comments, ...</p>
- </td>
- </tr>
- </table>
- </div>
- <span class="c8"><br>
- </span>
-
- <div class="c11">
- <table cellpadding="2" cellspacing="0"
- border="0" width="99%">
- <tr>
- <td bgcolor="#525D76" class="c12">
- <b>10. Versionning</b></td>
- </tr>
-
- <tr>
- <td>
- <span class="c8"><br>
- </span>
-
- <p class="c9">All .java files
- should have a <code class=
- "c14">@version</code> tag like the
- one below.</p>
-
- <div class="c13">
- <table cellpadding="2"
- cellspacing="2" border="1">
- <tr>
- <td>
+<h3>Line length</h3>
+<p>Avoid lines longer than 78 characters for Code, comments, ...</p>
+
+<h3>Versioning</h3>
+
+<p>All .java files should have a <code>@version</code> tag like the one below.</p>
+
<pre>
@version $Id$
</pre>
- </td>
- </tr>
- </table>
- </div>
-
- <table border="0" cellpadding="0"
- cellspacing="3" width="100%">
- <tr>
- <td valign="top" width="28">
- <img alt="Note" border="0"
- hspace="0" vspace="0" height=
- "29" width="28" src=
- "images/note.gif"></td>
-
- <td valign="top"><span class=
- "c10"><i>You just need to write
- <code class="c14">@version $Id:
- coding_conventions.xml,v 1.4
- 2001/08/22 10:36:45 vmassol Exp
- $</code> and CVS will add the
- rest during commits</i></span>
- </td>
- </tr>
- </table>
- <br>
- <br>
- <span class="c8"></span>
- </td>
- </tr>
- </table>
- </div>
- <span class="c8"><br>
- </span>
- </td>
- </tr>
- </table>
- </div>
- <br>
+
+<p><img align="left" alt="Note" border="0" height= "29" width="28" src="images/note.gif"><i>You just need to write <code >@version $Id: $</code> and CVS will add the rest during commits</i></p>
Index: release_process.html
===================================================================
RCS file: /cvsroot/mockobjects/mockobjects-java/doc/html/release_process.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- release_process.html 29 Aug 2002 12:17:21 -0000 1.1
+++ release_process.html 2 Sep 2002 11:35:07 -0000 1.2
@@ -1,153 +1,27 @@
- <div class="c10">
- <table cellpadding="2" cellspacing="0" border="0" width=
- "100%">
- <tr>
- <td bgcolor="#525D76" class="c7"><b>Introduction</b></td>
- </tr>
-
- <tr>
- <td>
- <span class="c8"><br>
- </span>
-
- <p class="c9">This document highlights our release
- process. It defines all the steps that need to be
- performed <b>before</b> releasing a new version of the
- Mock Objects project.</p>
- </td>
- </tr>
- </table>
- </div>
- <br>
+<h1>Release Process</h1>
+<h2>Introduction</h2>
+
+<p class="c9">This document highlights our release process. It defines all the steps that need to be performed <b>before</b> releasing a new version of the Mock Objects project.</p>
- <div class="c10">
- <table cellpadding="2" cellspacing="0" border="0" width=
- "100%">
- <tr>
- <td bgcolor="#525D76" class="c7"><b>General
- steps</b></td>
- </tr>
-
- <tr>
- <td>
- <span class="c8"><br>
- </span>
-
- <div class="c10">
- <table cellpadding="2" cellspacing="0" border="0"
- width="99%">
- <tr>
- <td bgcolor="#525D76" class="c11"><b>Decide on
- the content of a release</b></td>
- </tr>
-
- <tr>
- <td>
- <span class="c8"><br>
- </span>
-
- <p class="c9">Long before any release, we need
- to define what will go into that release, i.e.
- the list of tasks that need to be performed
- <b>prior</b> to that release. These tasks will
- be listed on the <a href="todo.html">Todo
- page</a>. Tasks can be proposed on the <a href=
- "http://sourceforge.net/mail/?group_id=18189">mailing
- list</a>.</p>
- </td>
- </tr>
- </table>
- </div>
- <span class="c8"><br>
- </span>
-
- <div class="c10">
- <table cellpadding="2" cellspacing="0" border="0"
- width="99%">
- <tr>
- <td bgcolor="#525D76" class="c11"><b>Deciding on
- doing a release</b></td>
- </tr>
-
- <tr>
- <td>
- <span class="c8"><br>
- </span>
-
- <p class="c9">Releasing a version is a
- community action that we all need to decide
- together (the committers of the project).
- Before <b>any</b> release, we will need to
- agree on doing a release. This entails sending
- a message on the <a href=
- "http://sourceforge.net/mail/?group_id=18189">mailing
- list</a> asking for a vote on the release. We
- will use the <a href=
- "http://jakarta.apache.org/site/decisions.html">
- Apache Jakarta system for voting</a>.</p>
- </td>
- </tr>
- </table>
- </div>
- <span class="c8"><br>
- </span>
-
- <div class="c10">
- <table cellpadding="2" cellspacing="0" border="0"
- width="99%">
- <tr>
- <td bgcolor="#525D76" class="c11"><b>Updating the
- Changes page</b></td>
- </tr>
-
- <tr>
- <td>
- <span class="c8"><br>
- </span>
-
- <p class="c9">The <a href=
- "changes.html">Changes page</a> need to be up
- to date at any time. The goal of this page is
- not to described fine-grained changes in CVS
- like "I have corrected a typo" but rather to
- advertise changes that are useful to end users
- (for example: "Improved the Mailing-list
- example by ..."). As it is very hard to
- remember everything that everyone has done, it
- is mandatory to fill this page as we do the
- modifications and not to wait till the release
- to fill it.</p>
- </td>
- </tr>
- </table>
- </div>
- <span class="c8"><br>
- </span>
- </td>
- </tr>
- </table>
- </div>
- <br>
+<h2>General steps</h2>
+<h3>Decide on the content of a release</h3>
+
+<p class="c9">Long before any release, we need to define what will go into that release, i.e. the list of tasks that need to be performed <b>prior</b> to that release. These tasks will be listed on the <a href="todo.html">Todo page</a>. Tasks can be proposed on the <a href="http://sourceforge.net/mail/?group_id=18189">mailing list</a>.</p>
+
+<h3>Deciding on doing a release</h3>
+
+<p>Releasing a version is a community action that we all need to decide together (the committers of the project). Before <b>any</b> release, we will need to agree on doing a release. This entails sending a message on the <a href= "http://sourceforge.net/mail/?group_id=18189">mailing list</a> asking for a vote on the release. We will use the <a href= "http://jakarta.apache.org/site/decisions.html"> Apache Jakarta system for voting</a>.</p>
+
+<h3>Updating the Changes page</h3>
+
+<p>The <a href= "changes.html">Changes page</a> need to be up to date at any time. The goal of this page is not to described fine-grained changes in CVS like "I have corrected a typo" but rather to advertise changes that are useful to end users (for example: "Improved the Mailing-list example by ..."). As it is very hard to remember everything that everyone has done, it is mandatory to fill this page as we do the modifications and not to wait till the release to fill it.</p>
- <div class="c10">
- <table cellpadding="2" cellspacing="0" border="0" width=
- "100%">
- <tr>
- <td bgcolor="#525D76" class="c7"><b>Detailed
- administrative steps</b></td>
- </tr>
-
- <tr>
- <td>
- <span class="c8"><br>
- </span>
+<h2>Detailed administrative steps</h2>
- <p class="c9">This is a detailed check list of all the
- steps involved to actually perform the release :</p>
+<p>This is a detailed check list of all the steps involved to actually perform the release :
- <blockquote>
<ol>
<li>Agree on a release (see above).</li>
@@ -212,8 +86,4 @@
<li>... then relax ! ;-)</li>
</ol>
- </blockquote>
- </td>
- </tr>
- </table>
- </div>
+</p>
Index: stylesheet.css
===================================================================
RCS file: /cvsroot/mockobjects/mockobjects-java/doc/html/stylesheet.css,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- stylesheet.css 2 Sep 2002 10:26:25 -0000 1.1
+++ stylesheet.css 2 Sep 2002 11:35:07 -0000 1.2
@@ -9,7 +9,7 @@
color: white;
background-color: #023264;
padding: 5;
- font-size:150%;
+ font-size:120%;
}
h2{
@@ -17,7 +17,7 @@
background-color: #023264;
padding: 3;
margin-left: 10;
- font-size:130%;
+ font-size:110%;
}
h3{
@@ -25,12 +25,13 @@
background-color: #023264;
padding: 3;
margin-left: 20;
- font-size:110%;
+ font-size:100%;
}
p{
margin-left: 30;
margin-right: 30;
+ font-size:12px;
}
:link { color: #525D76 }
Index: todo.html
===================================================================
RCS file: /cvsroot/mockobjects/mockobjects-java/doc/html/todo.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- todo.html 30 Aug 2002 14:50:32 -0000 1.2
+++ todo.html 2 Sep 2002 11:35:07 -0000 1.3
@@ -25,6 +25,7 @@
<h2>Version 0.02</h2>
<h3>Documentation</h3>
+<p>
<table cellpadding="2" cellspacing=
"2" border="0" width="100%">
<tr>
@@ -88,9 +89,11 @@
"c13"> </span> </td>
</tr>
</table>
+ </p>
<h3>Code</h3>
+<p>
<table cellpadding="2" cellspacing=
"2" border="0" width="100%">
<tr>
@@ -127,8 +130,10 @@
</td>
</tr>
</table>
+</p>
<h3>Build</h3>
+<p>
<table cellpadding="2" cellspacing=
"2" border="0" width="100%">
<tr>
@@ -162,3 +167,4 @@
Massol </span> </td>
</tr>
</table>
+</p>
|
