Fixed formatting, documentation added.

git-svn-id: https://svn.libreccm.org/ccm/trunk@4005 8810af33-2d31-482b-a856-94f89814c4df

ccm-core/src/com/arsdigita/templating/Templating.java

@@ -47,7 +47,7 @@ import org.apache.log4j.Logger;
 
 /**
  * An entry-point class for the functions of the templating package. The class
- * manages access to all theme files (XSL as well as css, pirctures, etc).
+ * manages access to all theme files (XSL as well as css, pictures, etc).
  *
  * This class maintains a cache of <code>XSLTemplate</code> objects, managed
  * via the <code>getTemplate</code> and <code>purgeTemplate</code> methods.
@@ -375,7 +375,7 @@ public class Templating {
         // installed into the ROOT context, the path includes the webapp part
         // which must be removed as well. 
         // It's a kind of HACK, unfortunately. If CCM is installed into the
-        // root context we don't detect whether the first part of the path
+        // root context, we don't detect whether the first part of the path
         // refers to another web application inside the host and assume local
         // and unrestricted access. The complete code should get refactored to
         // use ServletContext#getResource(path)

ccm-core/src/com/arsdigita/web/CCMDispatcherServlet.java

@@ -416,7 +416,7 @@ public class CCMDispatcherServlet extends BaseServlet {
         
         /**
          * Provides the context the application is executing. Usually all CCM
-         * applications will now execute in the samme webapp context. The 
+         * applications will now execute in the same webapp context. The 
          * app.getContextPath() return "" in this case where an application is
          * executing in no specific context but CCM's default.
          * @return The context path of the application's url, "" in case of

ccm-core/src/com/arsdigita/web/InternalRequestLocal.java

@@ -24,10 +24,10 @@ import javax.servlet.http.HttpServletRequest;
 import org.apache.log4j.Logger;
 
 /**
- * A class that provides request-framed control over a thread-local
+ * A class that provides request-framed control over a thread-local value.
- * value.  With such control, it is possible to safely reuse
+ * With such control, it is possible to safely reuse thread-local data across
- * thread-local data across requests.  For example, the following
+ * requests. For example, the following <code>InternalRequestLocal</code>
- * <code>InternalRequestLocal</code> reuses a <code>HashMap</code>.
+ * reuses a <code>HashMap</code>.
  *
  * <pre><blockquote>
  * class HashMapRequestLocal extends InternalRequestLocal {
@@ -75,14 +75,19 @@ import org.apache.log4j.Logger;
  */
 class InternalRequestLocal extends ThreadLocal {
 
+    /** Internal logger instance to faciliate debugging. Enable logging output
+     *  by editing /WEB-INF/conf/log4j.properties int the runtime environment
+     *  and set com.arsdigita.web.InternalRequestLocal=DEBUG 
+     *  by uncommenting or adding the line.                                   */
     private static final Logger s_log = 
                          Logger.getLogger(InternalRequestLocal.class);
 
     private static final ArrayList s_locals = new ArrayList();
 
     /**
-     * <p>Constructs a new InternalRequestLocal and registers it to be
+     * Constructs a new InternalRequestLocal and registers it to be
-     * initialized and cleared on each request.</p>
+     * initialized and cleared on each request.
+     * 
      */
     public InternalRequestLocal() {
         super();

ccm-core/src/com/arsdigita/web/Web.java

@@ -220,8 +220,8 @@ public class Web {
         // determine my own webapp context
         ServletContext myctx = getServletContext();
 
-        // Check for old style resourcePath format including a comma seoarated list
+        // Check for old style resourcePath format including a comma separated
-        // of webapps
+        // list of webapps
         if(resourcePath.indexOf(",") <= 0 ) {
             // no comma separated list found, process as normal