Return-Path: Delivered-To: apmail-directory-commits-archive@www.apache.org Received: (qmail 89030 invoked from network); 22 Feb 2007 01:56:05 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 22 Feb 2007 01:56:05 -0000 Received: (qmail 1081 invoked by uid 500); 22 Feb 2007 01:56:13 -0000 Delivered-To: apmail-directory-commits-archive@directory.apache.org Received: (qmail 1056 invoked by uid 500); 22 Feb 2007 01:56:13 -0000 Mailing-List: contact commits-help@directory.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@directory.apache.org Delivered-To: mailing list commits@directory.apache.org Received: (qmail 1045 invoked by uid 99); 22 Feb 2007 01:56:13 -0000 Received: from herse.apache.org (HELO herse.apache.org) (140.211.11.133) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 21 Feb 2007 17:56:13 -0800 X-ASF-Spam-Status: No, hits=-99.5 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO eris.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 21 Feb 2007 17:55:57 -0800 Received: by eris.apache.org (Postfix, from userid 65534) id 522291A9829; Wed, 21 Feb 2007 17:55:12 -0800 (PST) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r510342 [7/12] - in /directory/sandbox/oersoy/documentation.checklist.parent: ./ documentation.checklist.archetype/ documentation.checklist.archetype/src/ documentation.checklist.archetype/src/main/ documentation.checklist.archetype/src/mai... Date: Thu, 22 Feb 2007 01:55:06 -0000 To: commits@directory.apache.org From: oersoy@apache.org X-Mailer: svnmailer-1.1.0 Message-Id: <20070222015512.522291A9829@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/source/bakchecklist.xml URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/source/bakchecklist.xml?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/source/bakchecklist.xml (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/source/bakchecklist.xml Wed Feb 21 17:54:52 2007 @@ -0,0 +1,312 @@ + + + + + + + Importing the Apache Format Template + + Preferences > Java > Code Style > Formatter > Import]]> + + + Here is a link to the formatting.xml file formatting.xml

]]> + + 1 + + + + + Importing the Apache Code Template + + Window > Preferences > Java > Code Style > Code Templates > Import.]]> + + + Here is a link to the codetemplates.xml file codetemplates.xml]]> + + 0 + + + + + + + Creating a Package Level Javadoc Comment + + + + + +Create a summary of the various classes contained in this package and their relationships. +

+

+Provide a package specification with links to package wide specifications and APIs, that will +be helpful when reviewing the contained code. +

+

Also provide pointers to external architecture/detailed design documents.

+ +
+<html>
+<!--
+ * 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.
+-->
+
+<!-- $Id: package.html 464373 2007-01-08 03:11:32Z ole $ -->
+
+<body>
+<h2>Summary</h2>
+
+<p>This package contains Daemon scope <code>Runtime</code> implementations
+that may be useful during the <code>startup</code> or <code>shutdown</code>
+command execution of ApacheDS.</p>
+
+<h2>Package Specification</h2>
+(Just an example - TODO More daemon appropriate example)
+http://www.ipa.go.jp/security/rfc/RFC3377EN.html
+
+</body>
+</html>
+
+ +]]> + + + + + + Creating a Class Level Javadoc Comment + + + + +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.

+ +
+/**
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ *
+ * The Daemon Class enables ApacheDS to run as a daemon on the UNIX like OSs.
+ *
+ */
+public class Daemon 
+{
+   //Daemon code ...
+}
+
+]]> + + + + + + + + Creating Anonymous Inner Class Javadoc Comments + + + + + + 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. +

+ +
+    /**
+     * Create a default trigger for the entry.
+     * Note that the method uses an anonymous inner class
+     * <code>DefaultTrigger<code> create the trigger.
+     * Override this method with your own trigger
+     * implementation to assign a custom trigger to the entry.
+     */
+    public void createDefaultTrigger(){
+	...
+    }
+
+]]> + + + + + + + + Creating Method Javadoc Comments + + + + + +Below are some examples. Note the use of: +
    +
  • @param
    • +
  • @exception
    • +
  • @return
    • +
  • @todo
    • +
+ +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. +

+ +
+   /**
+    * 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 <code>commons-exec</code> once it reaches the 1.0 release.
+    */
+   public void run() throws MonkeyWrenchException {
+
+	if(isMonkeyWrenchInCode() )
+	throw new MonkeyWrenchException(monkeyWrench);
+	...;
+   }
+
+
+]]> + + + + + + Creating Constructor Javadoc Comments + + + + + +TODO +

+ +
+   /**
+    * Default constructor for Daemon
+    * Sets the initial number of threads to 10.
+    */
+   public Daemon() {
+      this.threads = 10;
+   }
+
+]]> + + + + + + Creating Field Javadoc Comments + + + + + +TODO +

+ +
+   /**
+    * Default constructor for Daemon
+    * Sets the initial number of threads to 10.
+    */
+   public Daemon() {
+      this.threads = 10;
+   }
+
+]]> + + + + + + + + + + Importing the Apache Code Template. + + Window > Preferences > Java > Code Style > Code Templates > Import.

]]> + + + Here is a link to the codetemplates.xml file codetemplates.xml]]> + + 1 + + + + + Importing the Apache Code Template. + + Window > Preferences > Java > Code Style > Code Templates > Import.

]]> + + + Here is a link to the codetemplates.xml file codetemplates.xml]]> + + 1 + + + + + Importing the Apache Code Template. + + Window > Preferences > Java > Code Style > Code Templates > Import.

]]> + + + Here is a link to the codetemplates.xml file codetemplates.xml]]> + + 1 + + + + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/source/bakrecipes.xml URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/source/bakrecipes.xml?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/source/bakrecipes.xml (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/source/bakrecipes.xml Wed Feb 21 17:54:52 2007 @@ -0,0 +1,32 @@ + + + + + + ![CDATA[Importing the Apache Format Template.]] + + + ![CDATA[Window > Preferences > Java > Code Style > Formatter + > Import]] + + + ![CDATA[<p>Here is a link to the formatting.xml file + <a + href="resources/formatting.xml">formatting.xml</a></p>]] + + 12 + + + Importing the Apache Code Template + + Window > Preferences > Java > Code Style > Code Templates > Import.]]> + + + Here is a link to the codetemplates.xml file codetemplates.xml]]> + + 11 + + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/source/checklist.xml URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/source/checklist.xml?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/source/checklist.xml (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/source/checklist.xml Wed Feb 21 17:54:52 2007 @@ -0,0 +1,60 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/source/recipes.xml URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/source/recipes.xml?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/source/recipes.xml (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/source/recipes.xml Wed Feb 21 17:54:52 2007 @@ -0,0 +1,254 @@ + + + + + Importing the Apache Format Template + + Preferences > Java > Code Style > Formatter > Import]]> + + + Here is a link to the formatting.xml file formatting.xml

]]> + + 01 + + + Importing the Apache Code Template + + Window > Preferences > Java > Code Style > Code Templates > Import.]]> + + + Here is a link to the codetemplates.xml file codetemplates.xml]]> + + 00 + + + + + + + Creating a Package Level Javadoc Comment + + + + + +Create a summary of the various classes contained in this package and their relationships. +

+

+Provide a package specification with links to package wide specifications and APIs, that will +be helpful when reviewing the contained code. +

+

Also provide pointers to external architecture/detailed design documents.

+ +
+<html>
+<!--
+ * 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.
+-->
+
+<!-- $Id: package.html 464373 2007-01-08 03:11:32Z ole $ -->
+
+<body>
+<h2>Summary</h2>
+
+<p>This package contains Daemon scope <code>Runtime</code> implementations
+that may be useful during the <code>startup</code> or <code>shutdown</code>
+command execution of ApacheDS.</p>
+
+<h2>Package Specification</h2>
+(Just an example - TODO More daemon appropriate example)
+http://www.ipa.go.jp/security/rfc/RFC3377EN.html
+
+</body>
+</html>
+
+ +]]> + + + + + + Creating a Class Level Javadoc Comment + + + + + 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.

+ + 
+            /**
+             * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+             *
+             * The Daemon Class enables ApacheDS to run as a daemon on the UNIX like OSs.
+             *
+             */
+            public class Daemon 
+            {
+               //Daemon code ...
+            }
+
+ ]]> + + + + + Creating Anonymous Inner Class Javadoc Comments + + + + + + 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. +

+ + 
+                /**
+                 * Create a default trigger for the entry.
+                 * Note that the method uses an anonymous inner class
+                 * <code>DefaultTrigger<code> create the trigger.
+                 * Override this method with your own trigger
+                 * implementation to assign a custom trigger to the entry.
+                 */
+                public void createDefaultTrigger(){
+               ...
+                }
+
+ ]]> + + + + + Creating Method Javadoc Comments + + + + + + Below are some examples. Note the use of: +
    +
  • @param
    • +
  • @exception
    • +
  • @return
    • +
  • @todo
    • +
+ + 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. +

+ + 
+               /**
+                * 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 <code>commons-exec</code> once it reaches the 1.0 release.
+                */
+               public void run() throws MonkeyWrenchException {
+            
+               if(isMonkeyWrenchInCode() )
+               throw new MonkeyWrenchException(monkeyWrench);
+               ...;
+               }
+            
+
+ ]]> + + + + + Creating Constructor Javadoc Comments + + + + + + TODO +

+ + 
+               /**
+                * Default constructor for Daemon
+                * Sets the initial number of threads to 10.
+                */
+               public Daemon() {
+                  this.threads = 10;
+               }
+
+ ]]> + + + + + Creating Field Javadoc Comments + + + + + + TODO +

+ + 
+               /**
+                * Default constructor for Daemon
+                * Sets the initial number of threads to 10.
+                */
+               public Daemon() {
+                  this.threads = 10;
+               }
+
+ ]]> + + + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/src/main/resources/css/book.css URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/src/main/resources/css/book.css?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/src/main/resources/css/book.css (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/src/main/resources/css/book.css Wed Feb 21 17:54:52 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.parent/documentation.checklist.test/src/main/resources/css/checklist.css URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/src/main/resources/css/checklist.css?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/src/main/resources/css/checklist.css (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/src/main/resources/css/checklist.css Wed Feb 21 17:54:52 2007 @@ -0,0 +1,3 @@ +.notRequired { + color: #959595; +} \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/src/main/resources/images/123.png URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/src/main/resources/images/123.png?view=auto&rev=510342 ============================================================================== Binary file - no diff available. Propchange: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/src/main/resources/images/123.png ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/src/main/resources/images/123.svg URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/src/main/resources/images/123.svg?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/src/main/resources/images/123.svg (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/src/main/resources/images/123.svg Wed Feb 21 17:54:52 2007 @@ -0,0 +1,66 @@ + + + + + + + + + + + ? 123 + + + Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/classes/recipes.xml URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/classes/recipes.xml?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/classes/recipes.xml (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/classes/recipes.xml Wed Feb 21 17:54:52 2007 @@ -0,0 +1,12 @@ + + + + + ![CDATA[Importing the Apache Format Template.]] + ![CDATA[Window > Preferences > Java > Code Style > Formatter > Import]] + ![CDATA[<p>Here is a link to the formatting.xml file <a href="resources/formatting.xml">formatting.xml</a></p>]] + 11 + 12 + + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/checklists/ideCheck/checklistideCheck.html URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/checklists/ideCheck/checklistideCheck.html?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/checklists/ideCheck/checklistideCheck.html (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/checklists/ideCheck/checklistideCheck.html Wed Feb 21 17:54:52 2007 @@ -0,0 +1,55 @@ + + + + + + + + + +IDE Preparation Checks + + + +

Checklist

+ +

IDE Preparation Checks

+ + + + + + + + + +
+ + Importing the Apache Format Template + + Import Format Template
+ + + + + + + + +
+ + Importing the Apache Code Template + + Import Code Template
+ + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/checklists/javadoc/checklistjavadoc.html URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/checklists/javadoc/checklistjavadoc.html?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/checklists/javadoc/checklistjavadoc.html (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/checklists/javadoc/checklistjavadoc.html Wed Feb 21 17:54:52 2007 @@ -0,0 +1,183 @@ + + + + + + + + + +Javadoc Comment Checks + + + +

Checklist

+ +

Javadoc Comment Checks

+ + + + + + + + + +
+ + Creating a Package Level Javadoc Comment + + Package Level
+ + + + + + + + +
+ + Creating a Class Level Javadoc Comment + + Class Level
+ + + + + + + + +
+ + Creating Anonymous Inner Class Javadoc Comments + + Anonymous Inner Classes
+

Member Level - Public

+ + + + + + + + +
+ + Creating Method Javadoc Comments + + Methods
+ + + + + + + + +
+ + Creating Constructor Javadoc Comments + + Constructors
+ + + + + + + + +
+ + Creating Field Javadoc Comments + + Fields
+

Member Level - Non Public

+ + + + + + + + +
+ + Creating Method Javadoc Comments + + Methods
+ + + + + + + + +
+ + Creating Constructor Javadoc Comments + + Constructors
+ + + + + + + + +
+ + Creating Field Javadoc Comments + + Fields
+ + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/ideCheck/recipe00.html URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/ideCheck/recipe00.html?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/ideCheck/recipe00.html (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/ideCheck/recipe00.html Wed Feb 21 17:54:52 2007 @@ -0,0 +1,58 @@ + + + + + Importing the Apache Format Template + + + + + + +

Challenge

+ +
+

Importing the Apache Format Template

+
+ +

Solution

+ +
+

+ Window > Preferences > Java > Code Style > Formatter > Import +

+
+ +

Discussion

+ +
+

+

Here is a link to the formatting.xml file formatting.xml

+

+ +

Related Challenges

+ + + + + + + + + + + +
+ + Importing the Apache Code Template + + Importing the Apache Code Template
+ + + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/ideCheck/recipe01.html URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/ideCheck/recipe01.html?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/ideCheck/recipe01.html (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/ideCheck/recipe01.html Wed Feb 21 17:54:52 2007 @@ -0,0 +1,58 @@ + + + + + Importing the Apache Code Template + + + + + + +

Challenge

+ +
+

Importing the Apache Code Template

+
+ +

Solution

+ +
+

+ Window > Preferences > Java > Code Style > Code Templates > Import. +

+
+ +

Discussion

+ +
+

+

Here is a link to the codetemplates.xml file codetemplates.xml +

+ +

Related Challenges

+ + + + + + + + + + + +
+ + Importing the Apache Format Template + + Importing the Apache Format Template
+ + + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe10.html URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe10.html?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe10.html (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe10.html Wed Feb 21 17:54:52 2007 @@ -0,0 +1,84 @@ + + + + + Creating a Package Level Javadoc Comment + + + + + + +

Challenge

+ +
+

Creating a Package Level Javadoc Comment

+
+ +

Solution

+ +
+

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

+
+ +

Discussion

+ +
+

+ +

+Create a summary of the various classes contained in this package and their relationships. +

+

+Provide a package specification with links to package wide specifications and APIs, that will +be helpful when reviewing the contained code. +

+

Also provide pointers to external architecture/detailed design documents.

+ +
+<html>
+<!--
+ * 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.
+-->
+
+<!-- $Id: package.html 464373 2007-01-08 03:11:32Z ole $ -->
+
+<body>
+<h2>Summary</h2>
+
+<p>This package contains Daemon scope <code>Runtime</code> implementations
+that may be useful during the <code>startup</code> or <code>shutdown</code>
+command execution of ApacheDS.</p>
+
+<h2>Package Specification</h2>
+(Just an example - TODO More daemon appropriate example)
+http://www.ipa.go.jp/security/rfc/RFC3377EN.html
+
+</body>
+</html>
+
+
+ +

+ +

Related Challenges

+ + + + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe11.html URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe11.html?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe11.html (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe11.html Wed Feb 21 17:54:52 2007 @@ -0,0 +1,53 @@ + + + + + Creating a Class Level Javadoc Comment + + + + + + +

Challenge

+ +
+

Creating a Class Level Javadoc Comment

+
+ +

Solution

+ +
+

+ Provide a description of what this class is used for, and place it right above the code that declares the class. +

+
+ +

Discussion

+ +
+

+ +

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.

+ + 
+            /**
+             * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+             *
+             * The Daemon Class enables ApacheDS to run as a daemon on the UNIX like OSs.
+             *
+             */
+            public class Daemon 
+            {
+               //Daemon code ...
+            }
+
+ +

+ +

Related Challenges

+ + + + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe12.html URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe12.html?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe12.html (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe12.html Wed Feb 21 17:54:52 2007 @@ -0,0 +1,60 @@ + + + + + Creating Anonymous Inner Class Javadoc Comments + + + + + + +

Challenge

+ +
+

Creating Anonymous Inner Class Javadoc Comments

+
+ +

Solution

+ +
+

+ + Describe the use of the anonymous inner class in the javadoc comments of methods that use the inner class. + +

+
+ +

Discussion

+ +
+

+ +

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

+ + 
+                /**
+                 * Create a default trigger for the entry.
+                 * Note that the method uses an anonymous inner class
+                 * <code>DefaultTrigger<code> create the trigger.
+                 * Override this method with your own trigger
+                 * implementation to assign a custom trigger to the entry.
+                 */
+                public void createDefaultTrigger(){
+               ...
+                }
+
+ +

+ +

Related Challenges

+ + + + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe13.html URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe13.html?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe13.html (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe13.html Wed Feb 21 17:54:52 2007 @@ -0,0 +1,88 @@ + + + + + Creating Method Javadoc Comments + + + + + + +

Challenge

+ +
+

Creating Method Javadoc Comments

+
+ +

Solution

+ +
+

+ Provide a description of what this method is used for, and place it right above the code that declares the method. +

+
+ +

Discussion

+ +
+

+ +

+ Below are some examples. Note the use of: +

    +
  • @param
    • +
  • @exception
    • +
  • @return
    • +
  • @todo
    • +
+ + 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. +

+ + 
+               /**
+                * 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 <code>commons-exec</code> once it reaches the 1.0 release.
+                */
+               public void run() throws MonkeyWrenchException {
+            
+               if(isMonkeyWrenchInCode() )
+               throw new MonkeyWrenchException(monkeyWrench);
+               ...;
+               }
+            
+
+ +

+ +

Related Challenges

+ + + + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe14.html URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe14.html?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe14.html (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe14.html Wed Feb 21 17:54:52 2007 @@ -0,0 +1,52 @@ + + + + + Creating Constructor Javadoc Comments + + + + + + +

Challenge

+ +
+

Creating Constructor Javadoc Comments

+
+ +

Solution

+ +
+

+ Provide a description of what the constructor is used for, and place it right above the code that declares the constructor. +

+
+ +

Discussion

+ +
+

+ +

+ TODO +

+ + 
+               /**
+                * Default constructor for Daemon
+                * Sets the initial number of threads to 10.
+                */
+               public Daemon() {
+                  this.threads = 10;
+               }
+
+ +

+ +

Related Challenges

+ + + + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe15.html URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe15.html?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe15.html (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/target/html/recipes/javadoc/recipe15.html Wed Feb 21 17:54:52 2007 @@ -0,0 +1,52 @@ + + + + + Creating Field Javadoc Comments + + + + + + +

Challenge

+ +
+

Creating Field Javadoc Comments

+
+ +

Solution

+ +
+

+ Provide a description of what the Field is used for, and place it right above the code that declares the constructor. +

+
+ +

Discussion

+ +
+

+ +

+ TODO +

+ + 
+               /**
+                * Default constructor for Daemon
+                * Sets the initial number of threads to 10.
+                */
+               public Daemon() {
+                  this.threads = 10;
+               }
+
+ +

+ +

Related Challenges

+ + + + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/toc.xml URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/toc.xml?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/toc.xml (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test/toc.xml Wed Feb 21 17:54:52 2007 @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/.classpath URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/.classpath?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/.classpath (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/.classpath Wed Feb 21 17:54:52 2007 @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/.project URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/.project?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/.project (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/.project Wed Feb 21 17:54:52 2007 @@ -0,0 +1,14 @@ + + documentation.checklist.test1 + + + + + org.eclipse.jdt.core.javabuilder + + + + + org.eclipse.jdt.core.javanature + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/.settings/org.eclipse.jdt.core.prefs URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/.settings/org.eclipse.jdt.core.prefs?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/.settings/org.eclipse.jdt.core.prefs (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/.settings/org.eclipse.jdt.core.prefs Wed Feb 21 17:54:52 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.parent/documentation.checklist.test1/META-INF/MANIFEST.MF URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/META-INF/MANIFEST.MF?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/META-INF/MANIFEST.MF (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/META-INF/MANIFEST.MF Wed Feb 21 17:54:52 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.parent/documentation.checklist.test1/about.html URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/about.html?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/about.html (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/about.html Wed Feb 21 17:54:52 2007 @@ -0,0 +1,34 @@ + + + + +About + + + +

About This Content

+ +

February 12, 2007

+

License

+ +

+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 +http://www.apache.org/licenses/LICENSE-2.0.html. +

+ +

+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 http://www.apache.org. +

+ + + Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/plugin.xml URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/plugin.xml?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/plugin.xml (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/plugin.xml Wed Feb 21 17:54:52 2007 @@ -0,0 +1,14 @@ + + + + + + + + + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/pom.xml URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/pom.xml?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/pom.xml (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/pom.xml Wed Feb 21 17:54:52 2007 @@ -0,0 +1,29 @@ + + + documentation.checklist.parent + org.apache.maven + 1.0-SNAPSHOT + + 4.0.0 + test + documentation.checklist.test1 + 1.0.0 + + + + org.apache.maven + documentation.checklist.mojo + 1.0-SNAPSHOT + true + + + generate + + generate + + + + + + + Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/source/checklist.xml URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/source/checklist.xml?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/source/checklist.xml (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/source/checklist.xml Wed Feb 21 17:54:52 2007 @@ -0,0 +1,60 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/source/recipes.xml URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/source/recipes.xml?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/source/recipes.xml (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/source/recipes.xml Wed Feb 21 17:54:52 2007 @@ -0,0 +1,254 @@ + + + + + Importing the Apache Format Template + + Preferences > Java > Code Style > Formatter > Import]]> + + + Here is a link to the formatting.xml file formatting.xml

]]> + + 01 + + + Importing the Apache Code Template + + Window > Preferences > Java > Code Style > Code Templates > Import.]]> + + + Here is a link to the codetemplates.xml file codetemplates.xml]]> + + 00 + + + + + + + Creating a Package Level Javadoc Comment + + + + + +Create a summary of the various classes contained in this package and their relationships. +

+

+Provide a package specification with links to package wide specifications and APIs, that will +be helpful when reviewing the contained code. +

+

Also provide pointers to external architecture/detailed design documents.

+ +
+<html>
+<!--
+ * 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.
+-->
+
+<!-- $Id: package.html 464373 2007-01-08 03:11:32Z ole $ -->
+
+<body>
+<h2>Summary</h2>
+
+<p>This package contains Daemon scope <code>Runtime</code> implementations
+that may be useful during the <code>startup</code> or <code>shutdown</code>
+command execution of ApacheDS.</p>
+
+<h2>Package Specification</h2>
+(Just an example - TODO More daemon appropriate example)
+http://www.ipa.go.jp/security/rfc/RFC3377EN.html
+
+</body>
+</html>
+
+
+]]> + + + + + + Creating a Class Level Javadoc Comment + + + + + 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.

+ + 
+            /**
+             * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+             *
+             * The Daemon Class enables ApacheDS to run as a daemon on the UNIX like OSs.
+             *
+             */
+            public class Daemon 
+            {
+               //Daemon code ...
+            }
+
+ ]]> + + + + + Creating Anonymous Inner Class Javadoc Comments + + + + + + 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. +

+ + 
+                /**
+                 * Create a default trigger for the entry.
+                 * Note that the method uses an anonymous inner class
+                 * <code>DefaultTrigger<code> create the trigger.
+                 * Override this method with your own trigger
+                 * implementation to assign a custom trigger to the entry.
+                 */
+                public void createDefaultTrigger(){
+               ...
+                }
+
+ ]]> + + + + + Creating Method Javadoc Comments + + + + + + Below are some examples. Note the use of: +
    +
  • @param
    • +
  • @exception
    • +
  • @return
    • +
  • @todo
    • +
+ + 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. +

+ + 
+               /**
+                * 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 <code>commons-exec</code> once it reaches the 1.0 release.
+                */
+               public void run() throws MonkeyWrenchException {
+            
+               if(isMonkeyWrenchInCode() )
+               throw new MonkeyWrenchException(monkeyWrench);
+               ...;
+               }
+            
+
+ ]]> + + + + + Creating Constructor Javadoc Comments + + + + + + TODO +

+ + 
+               /**
+                * Default constructor for Daemon
+                * Sets the initial number of threads to 10.
+                */
+               public Daemon() {
+                  this.threads = 10;
+               }
+
+ ]]> + + + + + Creating Field Javadoc Comments + + + + + + TODO +

+ + 
+               /**
+                * Default constructor for Daemon
+                * Sets the initial number of threads to 10.
+                */
+               public Daemon() {
+                  this.threads = 10;
+               }
+
+ ]]> + + + + \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/src/main/resources/css/book.css URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/src/main/resources/css/book.css?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/src/main/resources/css/book.css (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/src/main/resources/css/book.css Wed Feb 21 17:54:52 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.parent/documentation.checklist.test1/src/main/resources/css/checklist.css URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/src/main/resources/css/checklist.css?view=auto&rev=510342 ============================================================================== --- directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/src/main/resources/css/checklist.css (added) +++ directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/src/main/resources/css/checklist.css Wed Feb 21 17:54:52 2007 @@ -0,0 +1,3 @@ +.notRequired { + color: #959595; +} \ No newline at end of file Added: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/src/main/resources/images/123.png URL: http://svn.apache.org/viewvc/directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/src/main/resources/images/123.png?view=auto&rev=510342 ============================================================================== Binary file - no diff available. Propchange: directory/sandbox/oersoy/documentation.checklist.parent/documentation.checklist.test1/src/main/resources/images/123.png ------------------------------------------------------------------------------ svn:mime-type = application/octet-stream