directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From oer...@apache.org
Subject svn commit: r510290 [7/13] - in /directory/sandbox/oersoy: ./ documentation.checklist.archetype/ documentation.checklist.archetype/src/ documentation.checklist.archetype/src/main/ documentation.checklist.archetype/src/main/resources/ documentation.chec...
Date Wed, 21 Feb 2007 23:01:21 GMT
Added: directory/sandbox/oersoy/documentation.checklist.test/target/html/checklists/ideCheck/checklistideCheck.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test/target/html/checklists/ideCheck/checklistideCheck.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test/target/html/checklists/ideCheck/checklistideCheck.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test/target/html/checklists/ideCheck/checklistideCheck.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,55 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<title>IDE Preparation Checks</title>
+<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+<body>
+<h2>Checklist</h2>
+
+<h3>IDE Preparation Checks</h3>
+
+
+<table >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/ideCheck/recipe00.html">
+    				<img
+    					border="0" 
+    					title="Importing the Apache Format Template"
+    					alt="Importing the Apache Format Template"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Import Format Template</td>
+		</tr>
+	</tbody>
+</table>
+
+<table >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/ideCheck/recipe01.html">
+    				<img
+    					border="0" 
+    					title="Importing the Apache Code Template"
+    					alt="Importing the Apache Code Template"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Import Code Template</td>
+		</tr>
+	</tbody>
+</table>
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test/target/html/checklists/javadoc/checklistjavadoc.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test/target/html/checklists/javadoc/checklistjavadoc.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test/target/html/checklists/javadoc/checklistjavadoc.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test/target/html/checklists/javadoc/checklistjavadoc.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,183 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<title>Javadoc Comment Checks</title>
+<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+<body>
+<h2>Checklist</h2>
+
+<h3>Javadoc Comment Checks</h3>
+
+
+<table >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/javadoc/recipe10.html">
+    				<img
+    					border="0" 
+    					title="Creating a Package Level Javadoc Comment"
+    					alt="Creating a Package Level Javadoc Comment"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Package Level</td>
+		</tr>
+	</tbody>
+</table>
+
+<table >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/javadoc/recipe11.html">
+    				<img
+    					border="0" 
+    					title="Creating a Class Level Javadoc Comment"
+    					alt="Creating a Class Level Javadoc Comment"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Class Level</td>
+		</tr>
+	</tbody>
+</table>
+
+<table >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/javadoc/recipe12.html">
+    				<img
+    					border="0" 
+    					title="Creating Anonymous Inner Class Javadoc Comments"
+    					alt="Creating Anonymous Inner Class Javadoc Comments"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Anonymous Inner Classes</td>
+		</tr>
+	</tbody>
+</table>
+<h4> Member Level - Public </h4>
+
+<table >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/javadoc/recipe13.html">
+    				<img
+    					border="0" 
+    					title="Creating Method Javadoc Comments"
+    					alt="Creating Method Javadoc Comments"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Methods</td>
+		</tr>
+	</tbody>
+</table>
+
+<table >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/javadoc/recipe14.html">
+    				<img
+    					border="0" 
+    					title="Creating Constructor Javadoc Comments"
+    					alt="Creating Constructor Javadoc Comments"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Constructors</td>
+		</tr>
+	</tbody>
+</table>
+
+<table >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/javadoc/recipe15.html">
+    				<img
+    					border="0" 
+    					title="Creating Field Javadoc Comments"
+    					alt="Creating Field Javadoc Comments"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Fields</td>
+		</tr>
+	</tbody>
+</table>
+<h4> Member Level - Non Public </h4>
+
+<table  class="notRequired" >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/javadoc/recipe13.html">
+    				<img
+    					border="0" 
+    					title="Creating Method Javadoc Comments"
+    					alt="Creating Method Javadoc Comments"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Methods</td>
+		</tr>
+	</tbody>
+</table>
+
+<table  class="notRequired" >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/javadoc/recipe14.html">
+    				<img
+    					border="0" 
+    					title="Creating Constructor Javadoc Comments"
+    					alt="Creating Constructor Javadoc Comments"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Constructors</td>
+		</tr>
+	</tbody>
+</table>
+
+<table  class="notRequired" >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/javadoc/recipe15.html">
+    				<img
+    					border="0" 
+    					title="Creating Field Javadoc Comments"
+    					alt="Creating Field Javadoc Comments"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Fields</td>
+		</tr>
+	</tbody>
+</table>
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/ideCheck/recipe00.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/ideCheck/recipe00.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/ideCheck/recipe00.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/ideCheck/recipe00.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,58 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+  <title>Importing the Apache Format Template</title>
+   	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+	<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+	<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+  </head>
+<body>
+
+<h2>Challenge</h2>
+
+<div class="content">
+	<p>Importing the Apache Format Template</p>
+</div>
+
+<h2>Solution</h2>
+
+<div class="content">
+	<p>
+            Window > Preferences > Java > Code Style > Formatter > Import
+         </p>
+</div>
+
+<h2>Discussion</h2>
+
+<div class="content">
+<p>
+            <p>Here is a link to the formatting.xml file <a href="resources/formatting.xml">formatting.xml</a></p>
+         </p>
+
+<h2>Related Challenges</h2>
+
+
+<table>
+	<tbody>
+
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/ideCheck/recipe01.html">
+    				<img
+    					border="0" 
+    					title="Importing the Apache Code Template"
+    					alt="Importing the Apache Code Template"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Importing the Apache Code Template</td>
+		</tr>
+
+	</tbody>
+</table>
+
+
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/ideCheck/recipe01.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/ideCheck/recipe01.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/ideCheck/recipe01.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/ideCheck/recipe01.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,58 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+  <title>Importing the Apache Code Template</title>
+   	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+	<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+	<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+  </head>
+<body>
+
+<h2>Challenge</h2>
+
+<div class="content">
+	<p>Importing the Apache Code Template</p>
+</div>
+
+<h2>Solution</h2>
+
+<div class="content">
+	<p>
+            <b>Window > Preferences > Java > Code Style > Code Templates > Import</b>.
+         </p>
+</div>
+
+<h2>Discussion</h2>
+
+<div class="content">
+<p>
+            <p>Here is a link to the codetemplates.xml file <a href="resources/codetemplates.xml">codetemplates.xml</a>
+         </p>
+
+<h2>Related Challenges</h2>
+
+
+<table>
+	<tbody>
+
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/ideCheck/recipe00.html">
+    				<img
+    					border="0" 
+    					title="Importing the Apache Format Template"
+    					alt="Importing the Apache Format Template"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Importing the Apache Format Template</td>
+		</tr>
+
+	</tbody>
+</table>
+
+
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe10.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe10.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe10.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe10.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,84 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+  <title>Creating a Package Level Javadoc Comment</title>
+   	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+	<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+	<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+  </head>
+<body>
+
+<h2>Challenge</h2>
+
+<div class="content">
+	<p>Creating a Package Level Javadoc Comment</p>
+</div>
+
+<h2>Solution</h2>
+
+<div class="content">
+	<p>
+            Provide a description of what the package is used for and place it in package.html, along with the source files contained by the package.
+         </p>
+</div>
+
+<h2>Discussion</h2>
+
+<div class="content">
+<p>
+            
+<p>
+Create a summary of the various classes contained in this package and their relationships.
+</p>
+<p>
+Provide a package specification with links to package wide specifications and APIs, that will
+be helpful when reviewing the contained code.
+</p>
+<p>Also provide pointers to external architecture/detailed design documents.</p>
+
+<pre>
+&lt;html&gt;
+&lt;!--
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+--&gt;
+
+&lt!-- $Id: package.html 464373 2007-01-08 03:11:32Z ole $ --&gt;
+
+&lt;body&gt;
+&lt;h2&gt;Summary&lt;/h2&gt;
+
+&lt;p&gt;This package contains Daemon scope &lt;code>Runtime&lt;/code> implementations
+that may be useful during the &lt;code&gt;startup&lt;/code&gt; or &lt;code&gt;shutdown&lt;/code&gt;
+command execution of ApacheDS.&lt;/p&gt;
+
+&lt;h2&gt;Package Specification&lt;/h2&gt;
+(Just an example - TODO More daemon appropriate example)
+http://www.ipa.go.jp/security/rfc/RFC3377EN.html
+
+&lt;/body&gt;
+&lt;/html&gt;
+</pre>
+</div>
+
+         </p>
+
+<h2>Related Challenges</h2>
+
+
+
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe11.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe11.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe11.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe11.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,53 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+  <title>Creating a Class Level Javadoc Comment</title>
+   	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+	<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+	<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+  </head>
+<body>
+
+<h2>Challenge</h2>
+
+<div class="content">
+	<p>Creating a Class Level Javadoc Comment</p>
+</div>
+
+<h2>Solution</h2>
+
+<div class="content">
+	<p>
+            Provide a description of what this class is used for, and place it right above the code that declares the class.
+         </p>
+</div>
+
+<h2>Discussion</h2>
+
+<div class="content">
+<p>
+            
+            <p>Include an author tag. See the code box below for an example. Note that the author tag should be copied as is in the code box. This is so that the code base stays "Neutral" with respect to various contributors working on it.</p>
+            
+            <pre>
+            /**
+             * @author &lt;a href=&quot;mailto:dev@directory.apache.org&quot;&gt;Apache Directory Project&lt;/a&gt;
+             *
+             * The Daemon Class enables ApacheDS to run as a daemon on the UNIX like OSs.
+             *
+             */
+            public class Daemon 
+            {
+               //Daemon code ...
+            }
+            </pre>
+            
+         </p>
+
+<h2>Related Challenges</h2>
+
+
+
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe12.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe12.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe12.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe12.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,60 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+  <title>Creating Anonymous Inner Class Javadoc Comments</title>
+   	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+	<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+	<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+  </head>
+<body>
+
+<h2>Challenge</h2>
+
+<div class="content">
+	<p>Creating Anonymous Inner Class Javadoc Comments</p>
+</div>
+
+<h2>Solution</h2>
+
+<div class="content">
+	<p>
+            
+            Describe the use of the anonymous inner class in the javadoc comments of methods that use the inner class.
+            
+         </p>
+</div>
+
+<h2>Discussion</h2>
+
+<div class="content">
+<p>
+            
+            <p>
+               Javadoc ignores Anonymous inner class documentation.
+               If you are using anonymous inner classes, describe
+               the use of the anonymous inner class in the javadoc
+               comments of the methods that make use of the inner class.
+            </p>
+            
+            <pre class="codeblock">
+                /**
+                 * Create a default trigger for the entry.
+                 * Note that the method uses an anonymous inner class
+                 * &lt;code&gt;DefaultTrigger&lt;code&gt; create the trigger.
+                 * Override this method with your own trigger
+                 * implementation to assign a custom trigger to the entry.
+                 */
+                public void createDefaultTrigger(){
+               ...
+                }
+            </pre>
+            
+         </p>
+
+<h2>Related Challenges</h2>
+
+
+
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe13.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe13.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe13.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe13.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,88 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+  <title>Creating Method Javadoc Comments</title>
+   	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+	<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+	<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+  </head>
+<body>
+
+<h2>Challenge</h2>
+
+<div class="content">
+	<p>Creating Method Javadoc Comments</p>
+</div>
+
+<h2>Solution</h2>
+
+<div class="content">
+	<p>
+            Provide a description of what this method is used for, and place it right above the code that declares the method.
+         </p>
+</div>
+
+<h2>Discussion</h2>
+
+<div class="content">
+<p>
+            
+            <p>
+            Below are some examples.  Note the use of:
+            <ul>
+               <li>@param</li>
+               <li>@exception</li>
+               <li>@return</li>
+               <li>@todo</li>
+            </ul>
+            
+            With respect to @todo tags, please remove personal reminders
+            before submitting code to subversion.  Personal reminders are things
+            that can be taken care of quickly / are free of external dependencies.
+            The example included below uses a @todo tag to remind contributors that
+            the method the method should be refactored to use the commons-exec dependency,
+            once it reaches its 1.0 release.
+            </p>
+            
+            <pre class="codeblock">
+               /**
+                * Returns the current number of daemon threads
+                * @return int
+                */
+               public int getThreads() {
+                  return this.threads;
+               }
+            
+               /**
+                * Sets the number of Daemon processing threads
+                *
+                * @param int number of threads
+                */
+               public void setThreads(int threads) {
+                  this.threads = threads;
+               }
+            
+               /**
+                * Runs the Daemon
+                *
+                * @throws MonkeyWrenchException
+                * @todo Switch the implementation to &lt;code&gt;commons-exec&lt;/code&gt; once it reaches the 1.0 release.
+                */
+               public void run() throws MonkeyWrenchException {
+            
+               if(isMonkeyWrenchInCode() )
+               throw new MonkeyWrenchException(monkeyWrench);
+               ...;
+               }
+            
+            </pre>
+            
+         </p>
+
+<h2>Related Challenges</h2>
+
+
+
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe14.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe14.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe14.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe14.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,52 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+  <title>Creating Constructor Javadoc Comments</title>
+   	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+	<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+	<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+  </head>
+<body>
+
+<h2>Challenge</h2>
+
+<div class="content">
+	<p>Creating Constructor Javadoc Comments</p>
+</div>
+
+<h2>Solution</h2>
+
+<div class="content">
+	<p>
+            Provide a description of what the constructor is used for, and place it right above the code that declares the constructor.
+         </p>
+</div>
+
+<h2>Discussion</h2>
+
+<div class="content">
+<p>
+            
+            <p>
+            TODO
+            </p>
+            
+            <pre class="codeblock">
+               /**
+                * Default constructor for Daemon
+                * Sets the initial number of threads to 10.
+                */
+               public Daemon() {
+                  this.threads = 10;
+               }
+            </pre>
+            
+         </p>
+
+<h2>Related Challenges</h2>
+
+
+
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe15.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe15.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe15.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test/target/html/recipes/javadoc/recipe15.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,52 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+  <title>Creating Field Javadoc Comments</title>
+   	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+	<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+	<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+  </head>
+<body>
+
+<h2>Challenge</h2>
+
+<div class="content">
+	<p>Creating Field Javadoc Comments</p>
+</div>
+
+<h2>Solution</h2>
+
+<div class="content">
+	<p>
+            Provide a description of what the Field is used for, and place it right above the code that declares the constructor.
+         </p>
+</div>
+
+<h2>Discussion</h2>
+
+<div class="content">
+<p>
+            
+            <p>
+            TODO
+            </p>
+            
+            <pre class="codeblock">
+               /**
+                * Default constructor for Daemon
+                * Sets the initial number of threads to 10.
+                */
+               public Daemon() {
+                  this.threads = 10;
+               }
+            </pre>
+            
+         </p>
+
+<h2>Related Challenges</h2>
+
+
+
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test/toc.xml
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test/toc.xml?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test/toc.xml (added)
+++ directory/sandbox/oersoy/documentation.checklist.test/toc.xml Wed Feb 21 15:01:00 2007
@@ -0,0 +1,29 @@
+ 
+<?xml version="1.0" encoding="UTF-8"?>
+<?NLS TYPE="org.eclipse.help.toc"?>
+
+<toc label="ApacheDS Contributor Guide">
+	<topic label="Jar Artifact">
+		<topic label="Recipes">	
+			<topic label="IDE Preparation Checks">
+				<topic label="Importing the Apache Format Template" href="target/html/recipes/ideCheck/recipe00.html"/>
+				<topic label="Importing the Apache Code Template" href="target/html/recipes/ideCheck/recipe01.html"/>
+			</topic>	
+			<topic label="Javadoc Comment Checks">
+				<topic label="Creating a Package Level Javadoc Comment" href="target/html/recipes/javadoc/recipe10.html"/>
+				<topic label="Creating a Class Level Javadoc Comment" href="target/html/recipes/javadoc/recipe11.html"/>
+				<topic label="Creating Anonymous Inner Class Javadoc Comments" href="target/html/recipes/javadoc/recipe12.html"/>
+				<topic label="Creating Method Javadoc Comments" href="target/html/recipes/javadoc/recipe13.html"/>
+				<topic label="Creating Constructor Javadoc Comments" href="target/html/recipes/javadoc/recipe14.html"/>
+				<topic label="Creating Field Javadoc Comments" href="target/html/recipes/javadoc/recipe15.html"/>
+				<topic label="Creating Method Javadoc Comments" href="target/html/recipes/javadoc/recipe13.html"/>
+				<topic label="Creating Constructor Javadoc Comments" href="target/html/recipes/javadoc/recipe14.html"/>
+				<topic label="Creating Field Javadoc Comments" href="target/html/recipes/javadoc/recipe15.html"/>
+			</topic>
+		</topic>
+		<topic label="Checklists">	
+			<topic label="IDE Preparation Checks" href="target/html/checklists/ideCheck/checklistideCheck.html"/>	
+			<topic label="Javadoc Comment Checks" href="target/html/checklists/javadoc/checklistjavadoc.html"/>
+		</topic>
+	</topic>
+</toc>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/.classpath
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/.classpath?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/.classpath (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/.classpath Wed Feb 21 15:01:00 2007
@@ -0,0 +1,5 @@
+<classpath>
+  <classpathentry kind="src" path="src/main/resources"/>
+  <classpathentry kind="output" path="target/classes"/>
+  <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER"/>
+</classpath>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/.project
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/.project?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/.project (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/.project Wed Feb 21 15:01:00 2007
@@ -0,0 +1,14 @@
+<projectDescription>
+  <name>documentation.checklist.test1</name>
+  <comment/>
+  <projects/>
+  <buildSpec>
+    <buildCommand>
+      <name>org.eclipse.jdt.core.javabuilder</name>
+      <arguments/>
+    </buildCommand>
+  </buildSpec>
+  <natures>
+    <nature>org.eclipse.jdt.core.javanature</nature>
+  </natures>
+</projectDescription>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/.settings/org.eclipse.jdt.core.prefs
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/.settings/org.eclipse.jdt.core.prefs?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/.settings/org.eclipse.jdt.core.prefs (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/.settings/org.eclipse.jdt.core.prefs Wed Feb 21 15:01:00 2007
@@ -0,0 +1,5 @@
+#Wed Feb 21 13:49:10 CST 2007
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.5
+eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.source=1.5
+org.eclipse.jdt.core.compiler.compliance=1.5

Added: directory/sandbox/oersoy/documentation.checklist.test1/META-INF/MANIFEST.MF
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/META-INF/MANIFEST.MF?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/META-INF/MANIFEST.MF (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/META-INF/MANIFEST.MF Wed Feb 21 15:01:00 2007
@@ -0,0 +1,10 @@
+Manifest-Version: 1.0
+Bundle-Name: %pluginName
+Bundle-RequiredExecutionEnvironment: J2SE-1.5
+Bundle-Vendor: %providerName
+Bundle-ManifestVersion: 2
+Bundle-Localization: plugin
+Bundle-SymbolicName: org.apache.directory.contributor.guide.documentation; singleton:=true
+Require-Bundle: org.eclipse.help
+Bundle-Version: 1.0.0
+Eclipse-LazyStart: true
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/about.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/about.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/about.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/about.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,34 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
+<title>About</title>
+</head>
+<body lang="EN-US">
+
+<h2>About This Content</h2>
+ 
+<p>February 12, 2007</p>	
+<h3>License</h3>
+
+<p>
+All content ("Content") in this plug-in is made available
+by the The Apache Software Foundation.  The Content is provided 
+under the terms and conditions of the Apache Public License Version 2.0 ("ASL")
+unless otherwise indicated.  A copy of the ASL can be obtained via the URL
+<a href="http://www.apache.org/licenses/LICENSE-2.0.html">http://www.apache.org/licenses/LICENSE-2.0.html</a>.
+</p>
+
+<p>
+If the Content was obtained from a party other than the Apache Software Foundation, the Content is 
+being redistributed by that party ("Redistributor") and different terms and conditions may
+apply to your use of any object code in the Content.
+Contact the Redistributor or check the Redistributor's license if one was 
+provided with the Content.  Unless otherwise
+expressed below, the conditions and terms of the ASL still apply to any source code in the Content
+and such source code may be obtained at <a href="http://www.apache.org/">http://www.apache.org</a>.
+</p>
+
+</body>
+</html>

Added: directory/sandbox/oersoy/documentation.checklist.test1/plugin.xml
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/plugin.xml?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/plugin.xml (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/plugin.xml Wed Feb 21 15:01:00 2007
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?eclipse version="3.0"?>
+<plugin 
+	name="${name}"
+	id="testdocumentation.checklist.test1"
+	version = "1.0.0"
+	provider= "${url}">
+  <!-- ====================================================================== -->
+  <!-- Define primary TOC                                                     -->
+  <!-- ====================================================================== -->
+  <extension point="org.eclipse.help.toc">
+    <toc file="toc.xml" primary="true"/>
+  </extension>
+</plugin>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/pom.xml
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/pom.xml?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/pom.xml (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/pom.xml Wed Feb 21 15:01:00 2007
@@ -0,0 +1,29 @@
+<?xml version="1.0"?><project>
+  <parent>
+    <artifactId>documentation.checklist.parent</artifactId>
+    <groupId>org.apache.maven</groupId>
+    <version>1.0-SNAPSHOT</version>
+  </parent>
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>test</groupId>
+  <artifactId>documentation.checklist.test1</artifactId>
+  <version>1.0.0</version>
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven</groupId>
+        <artifactId>documentation.checklist.mojo</artifactId>
+        <version>1.0-SNAPSHOT</version>
+        <extensions>true</extensions>
+        <executions>
+          <execution>
+            <id>generate</id>
+            <goals>
+              <goal>generate</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+</project>

Added: directory/sandbox/oersoy/documentation.checklist.test1/source/checklist.xml
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/source/checklist.xml?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/source/checklist.xml (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/source/checklist.xml Wed Feb 21 15:01:00 2007
@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="ASCII"?>
+<checklist
+   xmlns="http://maven.apache.org/documentation/checklists/1.0.0"
+   name="ApacheDS Contributor Guide">
+   <packagingTarget
+      label="Jar Artifact"
+      type="jar" />
+   <checkGroup
+      id="ideCheck"
+      label="IDE Preparation Checks">
+      <checkItem
+         label="Import Format Template"
+         recipeReferenceId="00" />
+      <checkItem
+         label="Import Code Template"
+         recipeReferenceId="01" />
+   </checkGroup>
+   
+   <checkGroup
+      id="javadoc"
+      label="Javadoc Comment Checks">
+      <checkItem
+         label="Package Level"
+         recipeReferenceId="10" />
+      <checkItem
+         label="Class Level"
+         recipeReferenceId="11" />
+      <checkItem
+         label="Anonymous Inner Classes"
+         recipeReferenceId="12" />
+         
+      <checkItem
+         label="Methods"
+         recipeReferenceId="13">
+         <separator tagBody="Member Level - Public"/>
+      </checkItem>
+      <checkItem
+         label="Constructors"
+         recipeReferenceId="14" />
+      <checkItem
+         label="Fields"
+         recipeReferenceId="15" />
+         
+      <checkItem
+         required="false"
+         label="Methods"
+         recipeReferenceId="13">
+         <separator tagBody="Member Level - Non Public"/>
+      </checkItem>
+      <checkItem
+         required="false"
+         label="Constructors"
+         recipeReferenceId="14" />
+      <checkItem
+         required="false"
+         label="Fields"
+         recipeReferenceId="15" />
+         
+   </checkGroup>
+</checklist>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/source/recipes.xml
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/source/recipes.xml?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/source/recipes.xml (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/source/recipes.xml Wed Feb 21 15:01:00 2007
@@ -0,0 +1,254 @@
+<?xml version="1.0" encoding="ASCII"?>
+<recipes xmlns="http://maven.apache.org/documentation/recipes/1.0.0">
+   <recipeGroup
+      id="0"
+      label="IDE Preparation">
+      <recipe id="00">
+         <challenge>Importing the Apache Format Template</challenge>
+         <solution>
+            <![CDATA[Window > Preferences > Java > Code Style > Formatter > Import]]>
+         </solution>
+         <discussion>
+            <![CDATA[<p>Here is a link to the formatting.xml file <a href="resources/formatting.xml">formatting.xml</a></p>]]>
+         </discussion>
+         <relatedRecipeID>01</relatedRecipeID>
+      </recipe>
+      <recipe id="01">
+         <challenge>Importing the Apache Code Template</challenge>
+         <solution>
+            <![CDATA[<b>Window > Preferences > Java > Code Style > Code Templates > Import</b>.]]>
+         </solution>
+         <discussion>
+            <![CDATA[<p>Here is a link to the codetemplates.xml file <a href="resources/codetemplates.xml">codetemplates.xml</a>]]>
+         </discussion>
+         <relatedRecipeID>00</relatedRecipeID>
+      </recipe>
+   </recipeGroup>
+
+
+   <recipeGroup
+      id="1"
+      label="Javadoc Comment Checks">
+      <recipe id="10">
+         <challenge>Creating a Package Level Javadoc Comment</challenge>
+         <solution>
+            <![CDATA[Provide a description of what the package is used for and place it in package.html, along with the source files contained by the package.]]>
+         </solution>
+         <discussion>
+            <![CDATA[
+<p>
+Create a summary of the various classes contained in this package and their relationships.
+</p>
+<p>
+Provide a package specification with links to package wide specifications and APIs, that will
+be helpful when reviewing the contained code.
+</p>
+<p>Also provide pointers to external architecture/detailed design documents.</p>
+
+<pre>
+&lt;html&gt;
+&lt;!--
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+--&gt;
+
+&lt!-- $Id: package.html 464373 2007-01-08 03:11:32Z ole $ --&gt;
+
+&lt;body&gt;
+&lt;h2&gt;Summary&lt;/h2&gt;
+
+&lt;p&gt;This package contains Daemon scope &lt;code>Runtime&lt;/code> implementations
+that may be useful during the &lt;code&gt;startup&lt;/code&gt; or &lt;code&gt;shutdown&lt;/code&gt;
+command execution of ApacheDS.&lt;/p&gt;
+
+&lt;h2&gt;Package Specification&lt;/h2&gt;
+(Just an example - TODO More daemon appropriate example)
+http://www.ipa.go.jp/security/rfc/RFC3377EN.html
+
+&lt;/body&gt;
+&lt;/html&gt;
+</pre>
+</div>
+]]>
+         </discussion>
+      </recipe>
+
+
+      <recipe id="11">
+         <challenge>Creating a Class Level Javadoc Comment</challenge>
+         <solution>
+            <![CDATA[Provide a description of what this class is used for, and place it right above the code that declares the class.]]>
+         </solution>
+         <discussion>
+            <![CDATA[
+            <p>Include an author tag. See the code box below for an example. Note that the author tag should be copied as is in the code box. This is so that the code base stays "Neutral" with respect to various contributors working on it.</p>
+            
+            <pre>
+            /**
+             * @author &lt;a href=&quot;mailto:dev@directory.apache.org&quot;&gt;Apache Directory Project&lt;/a&gt;
+             *
+             * The Daemon Class enables ApacheDS to run as a daemon on the UNIX like OSs.
+             *
+             */
+            public class Daemon 
+            {
+               //Daemon code ...
+            }
+            </pre>
+            ]]>
+         </discussion>
+      </recipe>
+
+      <recipe id="12">
+         <challenge>Creating Anonymous Inner Class Javadoc Comments</challenge>
+         <solution>
+            <![CDATA[
+            Describe the use of the anonymous inner class in the javadoc comments of methods that use the inner class.
+            ]]>
+         </solution>
+         <discussion>
+            <![CDATA[
+            <p>
+               Javadoc ignores Anonymous inner class documentation.
+               If you are using anonymous inner classes, describe
+               the use of the anonymous inner class in the javadoc
+               comments of the methods that make use of the inner class.
+            </p>
+            
+            <pre class="codeblock">
+                /**
+                 * Create a default trigger for the entry.
+                 * Note that the method uses an anonymous inner class
+                 * &lt;code&gt;DefaultTrigger&lt;code&gt; create the trigger.
+                 * Override this method with your own trigger
+                 * implementation to assign a custom trigger to the entry.
+                 */
+                public void createDefaultTrigger(){
+               ...
+                }
+            </pre>
+            ]]>
+         </discussion>
+      </recipe>
+
+      <recipe id="13">
+         <challenge>Creating Method Javadoc Comments</challenge>
+         <solution>
+            <![CDATA[Provide a description of what this method is used for, and place it right above the code that declares the method.]]>
+         </solution>
+         <discussion>
+            <![CDATA[
+            <p>
+            Below are some examples.  Note the use of:
+            <ul>
+               <li>@param</li>
+               <li>@exception</li>
+               <li>@return</li>
+               <li>@todo</li>
+            </ul>
+            
+            With respect to @todo tags, please remove personal reminders
+            before submitting code to subversion.  Personal reminders are things
+            that can be taken care of quickly / are free of external dependencies.
+            The example included below uses a @todo tag to remind contributors that
+            the method the method should be refactored to use the commons-exec dependency,
+            once it reaches its 1.0 release.
+            </p>
+            
+            <pre class="codeblock">
+               /**
+                * Returns the current number of daemon threads
+                * @return int
+                */
+               public int getThreads() {
+                  return this.threads;
+               }
+            
+               /**
+                * Sets the number of Daemon processing threads
+                *
+                * @param int number of threads
+                */
+               public void setThreads(int threads) {
+                  this.threads = threads;
+               }
+            
+               /**
+                * Runs the Daemon
+                *
+                * @throws MonkeyWrenchException
+                * @todo Switch the implementation to &lt;code&gt;commons-exec&lt;/code&gt; once it reaches the 1.0 release.
+                */
+               public void run() throws MonkeyWrenchException {
+            
+               if(isMonkeyWrenchInCode() )
+               throw new MonkeyWrenchException(monkeyWrench);
+               ...;
+               }
+            
+            </pre>
+            ]]>
+         </discussion>
+      </recipe>
+
+      <recipe id="14">
+         <challenge>Creating Constructor Javadoc Comments</challenge>
+         <solution>
+            <![CDATA[Provide a description of what the constructor is used for, and place it right above the code that declares the constructor.]]>
+         </solution>
+         <discussion>
+            <![CDATA[
+            <p>
+            TODO
+            </p>
+            
+            <pre class="codeblock">
+               /**
+                * Default constructor for Daemon
+                * Sets the initial number of threads to 10.
+                */
+               public Daemon() {
+                  this.threads = 10;
+               }
+            </pre>
+            ]]>
+         </discussion>
+      </recipe>
+
+      <recipe id="15">
+         <challenge>Creating Field Javadoc Comments</challenge>
+         <solution>
+            <![CDATA[Provide a description of what the Field is used for, and place it right above the code that declares the constructor.]]>
+         </solution>
+         <discussion>
+            <![CDATA[
+            <p>
+            TODO
+            </p>
+            
+            <pre class="codeblock">
+               /**
+                * Default constructor for Daemon
+                * Sets the initial number of threads to 10.
+                */
+               public Daemon() {
+                  this.threads = 10;
+               }
+            </pre>
+            ]]>
+         </discussion>
+      </recipe>
+   </recipeGroup>
+</recipes>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/src/main/resources/css/book.css
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/src/main/resources/css/book.css?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/src/main/resources/css/book.css (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/src/main/resources/css/book.css Wed Feb 21 15:01:00 2007
@@ -0,0 +1,106 @@
+body {
+  font-family: sans-serif;
+  font-size: 10pt;
+  background-color: white;
+  color: black;
+  max-width: 800px;
+}
+
+h1 {
+  font-size: 18pt;
+}
+
+h2 {
+  font-size: 16pt;
+}
+
+h3 {
+  font-size: 14pt;
+}
+
+h4 {
+  font-size: 12pt;
+}
+
+table {
+  font-size: 10pt;
+}
+
+th {
+  font-weight: bold;
+}
+
+kbd {
+  font-family: monospace;
+  font-weight: bold;
+}
+
+var {
+  font-style: italic;
+}
+
+ol {
+  margin-bottom: 1em;
+}
+
+dt {
+  font-weight: bold;
+  margin-top: 1em;
+}
+
+li {
+  margin-top: 1em;
+}
+
+span.control {
+  font-weight: bold;
+}
+
+span.name {
+  font-style: italic;
+  font-weight: bold;
+}
+
+span.action {
+  font-style: italic;
+}
+
+span.code {
+  font-family: monospace;
+}
+
+span.menu {
+  color: #660033;
+  font-weight: bold;
+}
+
+span.filefolder {
+  font-family: monospace;
+}
+
+blockquote {
+  background-color: #e8e8e8;
+  border: 1pt black;
+  margin: 2em; border: 1px solid black;
+  padding: 1em;
+}
+
+.tasks, .reference, .faq {
+  padding-left: 18px;
+  font-size: 14pt;
+  background-image:url(images/bullet14.png);
+  background-repeat: no-repeat;
+  background-position: left;
+ }
+
+
+pre
+{
+border-width:thin;
+border-style: solid;
+font-family: "Courier New", Courier, mono;
+font-style: normal;
+font-size: 12px;
+padding-top: 6px;
+padding-bottom: 6px;
+}
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/src/main/resources/css/checklist.css
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/src/main/resources/css/checklist.css?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/src/main/resources/css/checklist.css (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/src/main/resources/css/checklist.css Wed Feb 21 15:01:00 2007
@@ -0,0 +1,3 @@
+.notRequired {
+  color: #959595;
+}
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/src/main/resources/images/123.png
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/src/main/resources/images/123.png?view=auto&rev=510290
==============================================================================
Binary file - no diff available.

Propchange: directory/sandbox/oersoy/documentation.checklist.test1/src/main/resources/images/123.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/sandbox/oersoy/documentation.checklist.test1/src/main/resources/images/123.svg
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/src/main/resources/images/123.svg?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/src/main/resources/images/123.svg (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/src/main/resources/images/123.svg Wed Feb 21 15:01:00 2007
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+<svg
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   version="1.0"
+   width="744.09448"
+   height="1052.3622"
+   id="svg2">
+  <defs
+     id="defs4" />
+  <g
+     id="layer1">
+    <g
+       transform="translate(991.42857,117.14286)"
+       id="g3179">
+      <rect
+         width="439.99997"
+         height="337.14288"
+         x="-862.85712"
+         y="-44.780663"
+         style="fill:#ffffff"
+         id="rect3163" />
+      <g
+         transform="matrix(0.9519651,0,0,0.9554455,-1961.6968,-451.04752)"
+         id="g3165">
+        <path
+           d="M 1485.7143 599.50507 A 164.28572 164.28572 0 1 1  1157.1429,599.50507 A 164.28572 164.28572 0 1 1  1485.7143 599.50507 z"
+           transform="matrix(1.3820751,0,0,0.9994664,-442.02789,0.319855)"
+           style="fill:#000000;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+           id="path2164" />
+        <path
+           d="M 1485.7143 599.50507 A 164.28572 164.28572 0 1 1  1157.1429,599.50507 A 164.28572 164.28572 0 1 1  1485.7143 599.50507 z"
+           transform="matrix(0.8036122,0,0,0.8036122,260.94097,116.30686)"
+           style="fill:#ffffff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+           id="path2166" />
+        <flowRoot
+           transform="matrix(5.1346254,0,0,4.7694236,-2758.6715,763.84383)"
+           style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;font-family:Bitstream Vera Sans"
+           id="flowRoot2168"
+           xml:space="preserve"><flowRegion
+             id="flowRegion2170"><rect
+               width="211.42857"
+               height="237.14285"
+               x="780"
+               y="-64.780678"
+               style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;font-family:Bitstream Vera Sans"
+               id="rect2172" /></flowRegion><flowPara
+             id="flowPara2174">?</flowPara><flowPara
+             id="flowPara2176" /></flowRoot>        <flowRoot
+           transform="matrix(1.3005494,0,0,1.4640653,448.65016,652.93293)"
+           style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;font-family:Bitstream Vera Sans"
+           id="flowRoot2178"
+           xml:space="preserve"><flowRegion
+             id="flowRegion2180"><rect
+               width="211.42857"
+               height="237.14285"
+               x="780"
+               y="-64.780678"
+               style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;font-family:Bitstream Vera Sans"
+               id="rect2182" /></flowRegion><flowPara
+             id="flowPara2188">123</flowPara><flowPara
+             id="flowPara2190"></flowPara></flowRoot>      </g>
+    </g>
+  </g>
+</svg>

Added: directory/sandbox/oersoy/documentation.checklist.test1/target/classes/css/book.css
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/target/classes/css/book.css?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/target/classes/css/book.css (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/target/classes/css/book.css Wed Feb 21 15:01:00 2007
@@ -0,0 +1,106 @@
+body {
+  font-family: sans-serif;
+  font-size: 10pt;
+  background-color: white;
+  color: black;
+  max-width: 800px;
+}
+
+h1 {
+  font-size: 18pt;
+}
+
+h2 {
+  font-size: 16pt;
+}
+
+h3 {
+  font-size: 14pt;
+}
+
+h4 {
+  font-size: 12pt;
+}
+
+table {
+  font-size: 10pt;
+}
+
+th {
+  font-weight: bold;
+}
+
+kbd {
+  font-family: monospace;
+  font-weight: bold;
+}
+
+var {
+  font-style: italic;
+}
+
+ol {
+  margin-bottom: 1em;
+}
+
+dt {
+  font-weight: bold;
+  margin-top: 1em;
+}
+
+li {
+  margin-top: 1em;
+}
+
+span.control {
+  font-weight: bold;
+}
+
+span.name {
+  font-style: italic;
+  font-weight: bold;
+}
+
+span.action {
+  font-style: italic;
+}
+
+span.code {
+  font-family: monospace;
+}
+
+span.menu {
+  color: #660033;
+  font-weight: bold;
+}
+
+span.filefolder {
+  font-family: monospace;
+}
+
+blockquote {
+  background-color: #e8e8e8;
+  border: 1pt black;
+  margin: 2em; border: 1px solid black;
+  padding: 1em;
+}
+
+.tasks, .reference, .faq {
+  padding-left: 18px;
+  font-size: 14pt;
+  background-image:url(images/bullet14.png);
+  background-repeat: no-repeat;
+  background-position: left;
+ }
+
+
+pre
+{
+border-width:thin;
+border-style: solid;
+font-family: "Courier New", Courier, mono;
+font-style: normal;
+font-size: 12px;
+padding-top: 6px;
+padding-bottom: 6px;
+}
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/target/classes/css/checklist.css
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/target/classes/css/checklist.css?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/target/classes/css/checklist.css (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/target/classes/css/checklist.css Wed Feb 21 15:01:00 2007
@@ -0,0 +1,3 @@
+.notRequired {
+  color: #959595;
+}
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/target/classes/images/123.png
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/target/classes/images/123.png?view=auto&rev=510290
==============================================================================
Binary file - no diff available.

Propchange: directory/sandbox/oersoy/documentation.checklist.test1/target/classes/images/123.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/sandbox/oersoy/documentation.checklist.test1/target/classes/images/123.svg
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/target/classes/images/123.svg?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/target/classes/images/123.svg (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/target/classes/images/123.svg Wed Feb 21 15:01:00 2007
@@ -0,0 +1,66 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+<svg
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns="http://www.w3.org/2000/svg"
+   version="1.0"
+   width="744.09448"
+   height="1052.3622"
+   id="svg2">
+  <defs
+     id="defs4" />
+  <g
+     id="layer1">
+    <g
+       transform="translate(991.42857,117.14286)"
+       id="g3179">
+      <rect
+         width="439.99997"
+         height="337.14288"
+         x="-862.85712"
+         y="-44.780663"
+         style="fill:#ffffff"
+         id="rect3163" />
+      <g
+         transform="matrix(0.9519651,0,0,0.9554455,-1961.6968,-451.04752)"
+         id="g3165">
+        <path
+           d="M 1485.7143 599.50507 A 164.28572 164.28572 0 1 1  1157.1429,599.50507 A 164.28572 164.28572 0 1 1  1485.7143 599.50507 z"
+           transform="matrix(1.3820751,0,0,0.9994664,-442.02789,0.319855)"
+           style="fill:#000000;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+           id="path2164" />
+        <path
+           d="M 1485.7143 599.50507 A 164.28572 164.28572 0 1 1  1157.1429,599.50507 A 164.28572 164.28572 0 1 1  1485.7143 599.50507 z"
+           transform="matrix(0.8036122,0,0,0.8036122,260.94097,116.30686)"
+           style="fill:#ffffff;fill-rule:evenodd;stroke:#000000;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1"
+           id="path2166" />
+        <flowRoot
+           transform="matrix(5.1346254,0,0,4.7694236,-2758.6715,763.84383)"
+           style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;font-family:Bitstream Vera Sans"
+           id="flowRoot2168"
+           xml:space="preserve"><flowRegion
+             id="flowRegion2170"><rect
+               width="211.42857"
+               height="237.14285"
+               x="780"
+               y="-64.780678"
+               style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;font-family:Bitstream Vera Sans"
+               id="rect2172" /></flowRegion><flowPara
+             id="flowPara2174">?</flowPara><flowPara
+             id="flowPara2176" /></flowRoot>        <flowRoot
+           transform="matrix(1.3005494,0,0,1.4640653,448.65016,652.93293)"
+           style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;font-family:Bitstream Vera Sans"
+           id="flowRoot2178"
+           xml:space="preserve"><flowRegion
+             id="flowRegion2180"><rect
+               width="211.42857"
+               height="237.14285"
+               x="780"
+               y="-64.780678"
+               style="font-size:48px;font-style:normal;font-variant:normal;font-weight:bold;font-stretch:normal;text-align:start;line-height:125%;writing-mode:lr-tb;text-anchor:start;fill:#ffffff;font-family:Bitstream Vera Sans"
+               id="rect2182" /></flowRegion><flowPara
+             id="flowPara2188">123</flowPara><flowPara
+             id="flowPara2190"></flowPara></flowRoot>      </g>
+    </g>
+  </g>
+</svg>

Added: directory/sandbox/oersoy/documentation.checklist.test1/target/documentation.checklist.test1-1.0.0.jar
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/target/documentation.checklist.test1-1.0.0.jar?view=auto&rev=510290
==============================================================================
Binary file - no diff available.

Propchange: directory/sandbox/oersoy/documentation.checklist.test1/target/documentation.checklist.test1-1.0.0.jar
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/sandbox/oersoy/documentation.checklist.test1/target/html/checklists/ideCheck/checklistideCheck.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/target/html/checklists/ideCheck/checklistideCheck.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/target/html/checklists/ideCheck/checklistideCheck.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/target/html/checklists/ideCheck/checklistideCheck.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,55 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<title>IDE Preparation Checks</title>
+<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+<body>
+<h2>Checklist</h2>
+
+<h3>IDE Preparation Checks</h3>
+
+
+<table >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/ideCheck/recipe00.html">
+    				<img
+    					border="0" 
+    					title="Importing the Apache Format Template"
+    					alt="Importing the Apache Format Template"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Import Format Template</td>
+		</tr>
+	</tbody>
+</table>
+
+<table >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/ideCheck/recipe01.html">
+    				<img
+    					border="0" 
+    					title="Importing the Apache Code Template"
+    					alt="Importing the Apache Code Template"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Import Code Template</td>
+		</tr>
+	</tbody>
+</table>
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/target/html/checklists/javadoc/checklistjavadoc.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/target/html/checklists/javadoc/checklistjavadoc.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/target/html/checklists/javadoc/checklistjavadoc.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/target/html/checklists/javadoc/checklistjavadoc.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,183 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+<title>Javadoc Comment Checks</title>
+<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+<body>
+<h2>Checklist</h2>
+
+<h3>Javadoc Comment Checks</h3>
+
+
+<table >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/javadoc/recipe10.html">
+    				<img
+    					border="0" 
+    					title="Creating a Package Level Javadoc Comment"
+    					alt="Creating a Package Level Javadoc Comment"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Package Level</td>
+		</tr>
+	</tbody>
+</table>
+
+<table >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/javadoc/recipe11.html">
+    				<img
+    					border="0" 
+    					title="Creating a Class Level Javadoc Comment"
+    					alt="Creating a Class Level Javadoc Comment"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Class Level</td>
+		</tr>
+	</tbody>
+</table>
+
+<table >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/javadoc/recipe12.html">
+    				<img
+    					border="0" 
+    					title="Creating Anonymous Inner Class Javadoc Comments"
+    					alt="Creating Anonymous Inner Class Javadoc Comments"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Anonymous Inner Classes</td>
+		</tr>
+	</tbody>
+</table>
+<h4> Member Level - Public </h4>
+
+<table >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/javadoc/recipe13.html">
+    				<img
+    					border="0" 
+    					title="Creating Method Javadoc Comments"
+    					alt="Creating Method Javadoc Comments"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Methods</td>
+		</tr>
+	</tbody>
+</table>
+
+<table >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/javadoc/recipe14.html">
+    				<img
+    					border="0" 
+    					title="Creating Constructor Javadoc Comments"
+    					alt="Creating Constructor Javadoc Comments"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Constructors</td>
+		</tr>
+	</tbody>
+</table>
+
+<table >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/javadoc/recipe15.html">
+    				<img
+    					border="0" 
+    					title="Creating Field Javadoc Comments"
+    					alt="Creating Field Javadoc Comments"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Fields</td>
+		</tr>
+	</tbody>
+</table>
+<h4> Member Level - Non Public </h4>
+
+<table  class="notRequired" >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/javadoc/recipe13.html">
+    				<img
+    					border="0" 
+    					title="Creating Method Javadoc Comments"
+    					alt="Creating Method Javadoc Comments"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Methods</td>
+		</tr>
+	</tbody>
+</table>
+
+<table  class="notRequired" >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/javadoc/recipe14.html">
+    				<img
+    					border="0" 
+    					title="Creating Constructor Javadoc Comments"
+    					alt="Creating Constructor Javadoc Comments"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Constructors</td>
+		</tr>
+	</tbody>
+</table>
+
+<table  class="notRequired" >
+	<tbody>
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/javadoc/recipe15.html">
+    				<img
+    					border="0" 
+    					title="Creating Field Javadoc Comments"
+    					alt="Creating Field Javadoc Comments"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Fields</td>
+		</tr>
+	</tbody>
+</table>
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/ideCheck/recipe00.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/ideCheck/recipe00.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/ideCheck/recipe00.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/ideCheck/recipe00.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,58 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+  <title>Importing the Apache Format Template</title>
+   	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+	<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+	<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+  </head>
+<body>
+
+<h2>Challenge</h2>
+
+<div class="content">
+	<p>Importing the Apache Format Template</p>
+</div>
+
+<h2>Solution</h2>
+
+<div class="content">
+	<p>
+            Window > Preferences > Java > Code Style > Formatter > Import
+         </p>
+</div>
+
+<h2>Discussion</h2>
+
+<div class="content">
+<p>
+            <p>Here is a link to the formatting.xml file <a href="resources/formatting.xml">formatting.xml</a></p>
+         </p>
+
+
+<h2>Related Challenges</h2>
+
+<table>
+	<tbody>
+
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/ideCheck/recipe01.html">
+    				<img
+    					border="0" 
+    					title="Importing the Apache Code Template"
+    					alt="Importing the Apache Code Template"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Importing the Apache Code Template</td>
+		</tr>
+
+	</tbody>
+</table>
+
+
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/ideCheck/recipe01.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/ideCheck/recipe01.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/ideCheck/recipe01.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/ideCheck/recipe01.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,58 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+  <title>Importing the Apache Code Template</title>
+   	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+	<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+	<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+  </head>
+<body>
+
+<h2>Challenge</h2>
+
+<div class="content">
+	<p>Importing the Apache Code Template</p>
+</div>
+
+<h2>Solution</h2>
+
+<div class="content">
+	<p>
+            <b>Window > Preferences > Java > Code Style > Code Templates > Import</b>.
+         </p>
+</div>
+
+<h2>Discussion</h2>
+
+<div class="content">
+<p>
+            <p>Here is a link to the codetemplates.xml file <a href="resources/codetemplates.xml">codetemplates.xml</a>
+         </p>
+
+
+<h2>Related Challenges</h2>
+
+<table>
+	<tbody>
+
+		<tr>
+			<td>
+    			<a
+    				href="../../recipes/ideCheck/recipe00.html">
+    				<img
+    					border="0" 
+    					title="Importing the Apache Format Template"
+    					alt="Importing the Apache Format Template"
+    					src="../../../../src/main/resources/images/123.png">
+    			</a>
+			</td>
+			<td>Importing the Apache Format Template</td>
+		</tr>
+
+	</tbody>
+</table>
+
+
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe10.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe10.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe10.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe10.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,82 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+  <title>Creating a Package Level Javadoc Comment</title>
+   	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+	<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+	<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+  </head>
+<body>
+
+<h2>Challenge</h2>
+
+<div class="content">
+	<p>Creating a Package Level Javadoc Comment</p>
+</div>
+
+<h2>Solution</h2>
+
+<div class="content">
+	<p>
+            Provide a description of what the package is used for and place it in package.html, along with the source files contained by the package.
+         </p>
+</div>
+
+<h2>Discussion</h2>
+
+<div class="content">
+<p>
+            
+<p>
+Create a summary of the various classes contained in this package and their relationships.
+</p>
+<p>
+Provide a package specification with links to package wide specifications and APIs, that will
+be helpful when reviewing the contained code.
+</p>
+<p>Also provide pointers to external architecture/detailed design documents.</p>
+
+<pre>
+&lt;html&gt;
+&lt;!--
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+--&gt;
+
+&lt!-- $Id: package.html 464373 2007-01-08 03:11:32Z ole $ --&gt;
+
+&lt;body&gt;
+&lt;h2&gt;Summary&lt;/h2&gt;
+
+&lt;p&gt;This package contains Daemon scope &lt;code>Runtime&lt;/code> implementations
+that may be useful during the &lt;code&gt;startup&lt;/code&gt; or &lt;code&gt;shutdown&lt;/code&gt;
+command execution of ApacheDS.&lt;/p&gt;
+
+&lt;h2&gt;Package Specification&lt;/h2&gt;
+(Just an example - TODO More daemon appropriate example)
+http://www.ipa.go.jp/security/rfc/RFC3377EN.html
+
+&lt;/body&gt;
+&lt;/html&gt;
+</pre>
+</div>
+
+         </p>
+
+
+
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe11.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe11.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe11.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe11.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,51 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+  <title>Creating a Class Level Javadoc Comment</title>
+   	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+	<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+	<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+  </head>
+<body>
+
+<h2>Challenge</h2>
+
+<div class="content">
+	<p>Creating a Class Level Javadoc Comment</p>
+</div>
+
+<h2>Solution</h2>
+
+<div class="content">
+	<p>
+            Provide a description of what this class is used for, and place it right above the code that declares the class.
+         </p>
+</div>
+
+<h2>Discussion</h2>
+
+<div class="content">
+<p>
+            
+            <p>Include an author tag. See the code box below for an example. Note that the author tag should be copied as is in the code box. This is so that the code base stays "Neutral" with respect to various contributors working on it.</p>
+            
+            <pre>
+            /**
+             * @author &lt;a href=&quot;mailto:dev@directory.apache.org&quot;&gt;Apache Directory Project&lt;/a&gt;
+             *
+             * The Daemon Class enables ApacheDS to run as a daemon on the UNIX like OSs.
+             *
+             */
+            public class Daemon 
+            {
+               //Daemon code ...
+            }
+            </pre>
+            
+         </p>
+
+
+
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe12.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe12.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe12.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe12.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,58 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+  <title>Creating Anonymous Inner Class Javadoc Comments</title>
+   	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+	<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+	<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+  </head>
+<body>
+
+<h2>Challenge</h2>
+
+<div class="content">
+	<p>Creating Anonymous Inner Class Javadoc Comments</p>
+</div>
+
+<h2>Solution</h2>
+
+<div class="content">
+	<p>
+            
+            Describe the use of the anonymous inner class in the javadoc comments of methods that use the inner class.
+            
+         </p>
+</div>
+
+<h2>Discussion</h2>
+
+<div class="content">
+<p>
+            
+            <p>
+               Javadoc ignores Anonymous inner class documentation.
+               If you are using anonymous inner classes, describe
+               the use of the anonymous inner class in the javadoc
+               comments of the methods that make use of the inner class.
+            </p>
+            
+            <pre class="codeblock">
+                /**
+                 * Create a default trigger for the entry.
+                 * Note that the method uses an anonymous inner class
+                 * &lt;code&gt;DefaultTrigger&lt;code&gt; create the trigger.
+                 * Override this method with your own trigger
+                 * implementation to assign a custom trigger to the entry.
+                 */
+                public void createDefaultTrigger(){
+               ...
+                }
+            </pre>
+            
+         </p>
+
+
+
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe13.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe13.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe13.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe13.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,86 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+  <title>Creating Method Javadoc Comments</title>
+   	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+	<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+	<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+  </head>
+<body>
+
+<h2>Challenge</h2>
+
+<div class="content">
+	<p>Creating Method Javadoc Comments</p>
+</div>
+
+<h2>Solution</h2>
+
+<div class="content">
+	<p>
+            Provide a description of what this method is used for, and place it right above the code that declares the method.
+         </p>
+</div>
+
+<h2>Discussion</h2>
+
+<div class="content">
+<p>
+            
+            <p>
+            Below are some examples.  Note the use of:
+            <ul>
+               <li>@param</li>
+               <li>@exception</li>
+               <li>@return</li>
+               <li>@todo</li>
+            </ul>
+            
+            With respect to @todo tags, please remove personal reminders
+            before submitting code to subversion.  Personal reminders are things
+            that can be taken care of quickly / are free of external dependencies.
+            The example included below uses a @todo tag to remind contributors that
+            the method the method should be refactored to use the commons-exec dependency,
+            once it reaches its 1.0 release.
+            </p>
+            
+            <pre class="codeblock">
+               /**
+                * Returns the current number of daemon threads
+                * @return int
+                */
+               public int getThreads() {
+                  return this.threads;
+               }
+            
+               /**
+                * Sets the number of Daemon processing threads
+                *
+                * @param int number of threads
+                */
+               public void setThreads(int threads) {
+                  this.threads = threads;
+               }
+            
+               /**
+                * Runs the Daemon
+                *
+                * @throws MonkeyWrenchException
+                * @todo Switch the implementation to &lt;code&gt;commons-exec&lt;/code&gt; once it reaches the 1.0 release.
+                */
+               public void run() throws MonkeyWrenchException {
+            
+               if(isMonkeyWrenchInCode() )
+               throw new MonkeyWrenchException(monkeyWrench);
+               ...;
+               }
+            
+            </pre>
+            
+         </p>
+
+
+
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe14.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe14.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe14.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe14.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,50 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+  <title>Creating Constructor Javadoc Comments</title>
+   	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+	<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+	<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+  </head>
+<body>
+
+<h2>Challenge</h2>
+
+<div class="content">
+	<p>Creating Constructor Javadoc Comments</p>
+</div>
+
+<h2>Solution</h2>
+
+<div class="content">
+	<p>
+            Provide a description of what the constructor is used for, and place it right above the code that declares the constructor.
+         </p>
+</div>
+
+<h2>Discussion</h2>
+
+<div class="content">
+<p>
+            
+            <p>
+            TODO
+            </p>
+            
+            <pre class="codeblock">
+               /**
+                * Default constructor for Daemon
+                * Sets the initial number of threads to 10.
+                */
+               public Daemon() {
+                  this.threads = 10;
+               }
+            </pre>
+            
+         </p>
+
+
+
+</body>
+</html>
\ No newline at end of file

Added: directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe15.html
URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe15.html?view=auto&rev=510290
==============================================================================
--- directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe15.html (added)
+++ directory/sandbox/oersoy/documentation.checklist.test1/target/html/recipes/javadoc/recipe15.html Wed Feb 21 15:01:00 2007
@@ -0,0 +1,50 @@
+ 
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+  <head>
+  <title>Creating Field Javadoc Comments</title>
+   	<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+	<link href="../../../../src/main/resources/css/book.css" rel="stylesheet" type="text/css">
+	<link href="../../../../src/main/resources/css/checklist.css" rel="stylesheet" type="text/css">
+  </head>
+<body>
+
+<h2>Challenge</h2>
+
+<div class="content">
+	<p>Creating Field Javadoc Comments</p>
+</div>
+
+<h2>Solution</h2>
+
+<div class="content">
+	<p>
+            Provide a description of what the Field is used for, and place it right above the code that declares the constructor.
+         </p>
+</div>
+
+<h2>Discussion</h2>
+
+<div class="content">
+<p>
+            
+            <p>
+            TODO
+            </p>
+            
+            <pre class="codeblock">
+               /**
+                * Default constructor for Daemon
+                * Sets the initial number of threads to 10.
+                */
+               public Daemon() {
+                  this.threads = 10;
+               }
+            </pre>
+            
+         </p>
+
+
+
+</body>
+</html>
\ No newline at end of file



Mime
View raw message