Author: pier
Date: Thu Nov 4 15:55:21 2004
New Revision: 56637
Modified:
cocoon/whiteboard/kernel/sources/blocks/jasper/src/org/apache/cocoon/blocks/jasper/JasperServlet.java
cocoon/whiteboard/kernel/sources/extensions/jaxp/src/org/apache/cocoon/kernel/plugins/JaxpBuilderPlugin.java
cocoon/whiteboard/kernel/sources/extensions/jaxp/src/org/apache/cocoon/kernel/plugins/JaxpParserPlugin.java
cocoon/whiteboard/kernel/sources/extensions/jaxp/src/org/apache/cocoon/kernel/plugins/JaxpPlugin.java
cocoon/whiteboard/kernel/sources/extensions/jaxp/src/org/apache/cocoon/kernel/plugins/JaxpTransformerPlugin.java
cocoon/whiteboard/kernel/sources/interfaces/jaxp/src/org/apache/cocoon/interfaces/jaxp/AbstractProvider.java
cocoon/whiteboard/kernel/sources/interfaces/jaxp/src/org/apache/cocoon/interfaces/jaxp/JaxpException.java
cocoon/whiteboard/kernel/sources/runtime/org/apache/cocoon/kernel/plugins/AbstractPlugin.java
cocoon/whiteboard/kernel/sources/runtime/org/apache/cocoon/kernel/plugins/Utilities.java
cocoon/whiteboard/kernel/sources/startup/org/apache/cocoon/kernel/startup/KernelLoader.java
cocoon/whiteboard/kernel/sources/startup/org/apache/cocoon/kernel/startup/Main.java
cocoon/whiteboard/kernel/sources/startup/org/apache/cocoon/kernel/startup/StartupKernel.java
Log:
We will not live without JavaDoc comments!!!
Modified:
cocoon/whiteboard/kernel/sources/blocks/jasper/src/org/apache/cocoon/blocks/jasper/JasperServlet.java
==============================================================================
---
cocoon/whiteboard/kernel/sources/blocks/jasper/src/org/apache/cocoon/blocks/jasper/JasperServlet.java
(original)
+++
cocoon/whiteboard/kernel/sources/blocks/jasper/src/org/apache/cocoon/blocks/jasper/JasperServlet.java
Thu Nov 4 15:55:21 2004
@@ -32,7 +32,8 @@
import org.apache.jasper.servlet.JspServlet;
/**
- * <p>TODO.</p>
+ * <p>A simple servlet wrapping around Tomcat's Jasper and providing the
+ * approptiate classpath to the JSP compiler.</p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Pier Fumagalli</a>
* @author Copyright © 2000-2004 <a href="http://www.apache.org/";>The
Apache
Modified:
cocoon/whiteboard/kernel/sources/extensions/jaxp/src/org/apache/cocoon/kernel/plugins/JaxpBuilderPlugin.java
==============================================================================
---
cocoon/whiteboard/kernel/sources/extensions/jaxp/src/org/apache/cocoon/kernel/plugins/JaxpBuilderPlugin.java
(original)
+++
cocoon/whiteboard/kernel/sources/extensions/jaxp/src/org/apache/cocoon/kernel/plugins/JaxpBuilderPlugin.java
Thu Nov 4 15:55:21 2004
@@ -19,7 +19,8 @@
import org.apache.cocoon.interfaces.jaxp.JaxpException;
/**
- * <p>TODO.</p>
+ * <p>A kernel plugin interoperating with the [EMAIL PROTECTED]
DocumentBuilderFactory}
+ * static methods in the JAXP API.</p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Pier Fumagalli</a>
* @author Copyright © 2000-2004 <a href="http://www.apache.org/";>The
Apache
@@ -68,7 +69,7 @@
private DocumentBuilderFactory instance = null;
/**
- * <p>Create a new instance of this [EMAIL PROTECTED] Factory}.</p>
+ * <p>Create a new instance of this [EMAIL PROTECTED]
DocumentBuilderFactory}.</p>
*/
public Factory() {
try {
Modified:
cocoon/whiteboard/kernel/sources/extensions/jaxp/src/org/apache/cocoon/kernel/plugins/JaxpParserPlugin.java
==============================================================================
---
cocoon/whiteboard/kernel/sources/extensions/jaxp/src/org/apache/cocoon/kernel/plugins/JaxpParserPlugin.java
(original)
+++
cocoon/whiteboard/kernel/sources/extensions/jaxp/src/org/apache/cocoon/kernel/plugins/JaxpParserPlugin.java
Thu Nov 4 15:55:21 2004
@@ -21,7 +21,8 @@
import org.xml.sax.SAXNotSupportedException;
/**
- * <p>TODO.</p>
+ * <p>A kernel plugin interoperating with the [EMAIL PROTECTED]
SAXParserFactory}
+ * static methods in the JAXP API.</p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Pier Fumagalli</a>
* @author Copyright © 2000-2004 <a href="http://www.apache.org/";>The
Apache
@@ -70,7 +71,7 @@
private SAXParserFactory instance = null;
/**
- * <p>Create a new instance of this [EMAIL PROTECTED] Factory}.</p>
+ * <p>Create a new instance of this [EMAIL PROTECTED]
SAXParserFactory}.</p>
*/
public Factory() {
try {
Modified:
cocoon/whiteboard/kernel/sources/extensions/jaxp/src/org/apache/cocoon/kernel/plugins/JaxpPlugin.java
==============================================================================
---
cocoon/whiteboard/kernel/sources/extensions/jaxp/src/org/apache/cocoon/kernel/plugins/JaxpPlugin.java
(original)
+++
cocoon/whiteboard/kernel/sources/extensions/jaxp/src/org/apache/cocoon/kernel/plugins/JaxpPlugin.java
Thu Nov 4 15:55:21 2004
@@ -23,7 +23,7 @@
import org.apache.cocoon.kernel.deployment.Instance;
/**
- * <p>TODO.</p>
+ * <p>The core plugin for the JAXP family of plugins.</p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Pier Fumagalli</a>
* @author Copyright © 2000-2004 <a href="http://www.apache.org/";>The
Apache
Modified:
cocoon/whiteboard/kernel/sources/extensions/jaxp/src/org/apache/cocoon/kernel/plugins/JaxpTransformerPlugin.java
==============================================================================
---
cocoon/whiteboard/kernel/sources/extensions/jaxp/src/org/apache/cocoon/kernel/plugins/JaxpTransformerPlugin.java
(original)
+++
cocoon/whiteboard/kernel/sources/extensions/jaxp/src/org/apache/cocoon/kernel/plugins/JaxpTransformerPlugin.java
Thu Nov 4 15:55:21 2004
@@ -26,7 +26,8 @@
import org.xml.sax.XMLFilter;
/**
- * <p>TODO.</p>
+ * <p>A kernel plugin interoperating with the [EMAIL PROTECTED]
SAXTransformerFactory}
+ * static methods in the JAXP API.</p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Pier Fumagalli</a>
* @author Copyright © 2000-2004 <a href="http://www.apache.org/";>The
Apache
@@ -75,7 +76,7 @@
private SAXTransformerFactory instance = null;
/**
- * <p>Create a new instance of this [EMAIL PROTECTED] Factory}.</p>
+ * <p>Create a new instance of this [EMAIL PROTECTED]
SAXTransformerFactory}.</p>
*/
public Factory() {
try {
Modified:
cocoon/whiteboard/kernel/sources/interfaces/jaxp/src/org/apache/cocoon/interfaces/jaxp/AbstractProvider.java
==============================================================================
---
cocoon/whiteboard/kernel/sources/interfaces/jaxp/src/org/apache/cocoon/interfaces/jaxp/AbstractProvider.java
(original)
+++
cocoon/whiteboard/kernel/sources/interfaces/jaxp/src/org/apache/cocoon/interfaces/jaxp/AbstractProvider.java
Thu Nov 4 15:55:21 2004
@@ -13,7 +13,7 @@
package org.apache.cocoon.interfaces.jaxp;
/**
- * <p>TODO.</p>
+ * <p>The default base implementation of all instances of [EMAIL PROTECTED]
JaxpProvider}.</p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Pier Fumagalli</a>
* @author Copyright © 2000-2004 <a href="http://www.apache.org/";>The
Apache
Modified:
cocoon/whiteboard/kernel/sources/interfaces/jaxp/src/org/apache/cocoon/interfaces/jaxp/JaxpException.java
==============================================================================
---
cocoon/whiteboard/kernel/sources/interfaces/jaxp/src/org/apache/cocoon/interfaces/jaxp/JaxpException.java
(original)
+++
cocoon/whiteboard/kernel/sources/interfaces/jaxp/src/org/apache/cocoon/interfaces/jaxp/JaxpException.java
Thu Nov 4 15:55:21 2004
@@ -13,7 +13,8 @@
package org.apache.cocoon.interfaces.jaxp;
/**
- * <p>TODO.</p>
+ * <p>The [EMAIL PROTECTED] JaxpException} is thrown whenever an error
occurred accessing the
+ * JAXP API by the kernel framework.</p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Pier Fumagalli</a>
* @author Copyright © 2000-2004 <a href="http://www.apache.org/";>The
Apache
Modified:
cocoon/whiteboard/kernel/sources/runtime/org/apache/cocoon/kernel/plugins/AbstractPlugin.java
==============================================================================
---
cocoon/whiteboard/kernel/sources/runtime/org/apache/cocoon/kernel/plugins/AbstractPlugin.java
(original)
+++
cocoon/whiteboard/kernel/sources/runtime/org/apache/cocoon/kernel/plugins/AbstractPlugin.java
Thu Nov 4 15:55:21 2004
@@ -18,7 +18,7 @@
import org.apache.cocoon.kernel.startup.StartupKernel;
/**
- * <p>TODO.</p>
+ * <p>A default minimal implementation of the [EMAIL PROTECTED] Plugin}
interface.</p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Pier Fumagalli</a>
* @author Copyright © 2000-2004 <a href="http://www.apache.org/";>The
Apache
Modified:
cocoon/whiteboard/kernel/sources/runtime/org/apache/cocoon/kernel/plugins/Utilities.java
==============================================================================
---
cocoon/whiteboard/kernel/sources/runtime/org/apache/cocoon/kernel/plugins/Utilities.java
(original)
+++
cocoon/whiteboard/kernel/sources/runtime/org/apache/cocoon/kernel/plugins/Utilities.java
Thu Nov 4 15:55:21 2004
@@ -15,7 +15,7 @@
import org.apache.cocoon.kernel.deployment.Instance;
/**
- * <p>TODO.</p>
+ * <p>Shared kernel [EMAIL PROTECTED] Plugin} uptilities.</p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Pier Fumagalli</a>
* @author Copyright © 2000-2004 <a href="http://www.apache.org/";>The
Apache
Modified:
cocoon/whiteboard/kernel/sources/startup/org/apache/cocoon/kernel/startup/KernelLoader.java
==============================================================================
---
cocoon/whiteboard/kernel/sources/startup/org/apache/cocoon/kernel/startup/KernelLoader.java
(original)
+++
cocoon/whiteboard/kernel/sources/startup/org/apache/cocoon/kernel/startup/KernelLoader.java
Thu Nov 4 15:55:21 2004
@@ -19,7 +19,9 @@
import java.util.Set;
/**
- * <p>TODO.</p>
+ * <p>The [EMAIL PROTECTED] KernelLoader} implementation provides the root
[EMAIL PROTECTED] ClassLoader}
+ * loading the kernel, and few utility methods to prepare [EMAIL PROTECTED]
StartupKernel}
+ * instances.</p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Pier Fumagalli</a>
* @author Copyright © 2000-2004 <a href="http://www.apache.org/";>The
Apache
Modified:
cocoon/whiteboard/kernel/sources/startup/org/apache/cocoon/kernel/startup/Main.java
==============================================================================
---
cocoon/whiteboard/kernel/sources/startup/org/apache/cocoon/kernel/startup/Main.java
(original)
+++
cocoon/whiteboard/kernel/sources/startup/org/apache/cocoon/kernel/startup/Main.java
Thu Nov 4 15:55:21 2004
@@ -25,17 +25,6 @@
/**
* <p>A simple class initializing a [EMAIL PROTECTED] Kernel} from a the
command line.</p>
- *
- * <p>Note, to properly allow static factories distributed with the [EMAIL
PROTECTED] Kernel}
- * to be instantiated and returned to the individual blocks, it is <b>strongly
- * suggested</b> that this [EMAIL PROTECTED] Main} class and its enclosing JAR
archive are
- * loaded as an <i>endorsed class</i>.</p>
- *
- * <p>The <i>system property</i> <code>java.endorsed.dirs</code> controls what
code
- * is loaded as an endorsed class. To specify this on the command line, use the
- * following syntax:</p>
- *
- * <p><code>java -Djava.endorsed.dirs=<i>directory</i> ...</code></p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Pier Fumagalli</a>
* @author Copyright © 2000-2004 <a href="http://www.apache.org/";>The
Apache
Modified:
cocoon/whiteboard/kernel/sources/startup/org/apache/cocoon/kernel/startup/StartupKernel.java
==============================================================================
---
cocoon/whiteboard/kernel/sources/startup/org/apache/cocoon/kernel/startup/StartupKernel.java
(original)
+++
cocoon/whiteboard/kernel/sources/startup/org/apache/cocoon/kernel/startup/StartupKernel.java
Thu Nov 4 15:55:21 2004
@@ -16,7 +16,8 @@
import org.apache.cocoon.kernel.configuration.Configuration;
/**
- * <p>TODO.</p>
+ * <p>An extension to the [EMAIL PROTECTED] Kernel} interface defining a way
to initialize
+ * and destroy the kernel framework.</p>
*
* @author <a href="mailto:[EMAIL PROTECTED]">Pier Fumagalli</a>
* @author Copyright © 2000-2004 <a href="http://www.apache.org/";>The
Apache
