svn commit: r653724 - in /forrest/trunk/main/java/org/apache/forrest/locationmap: lm/MountNode.java source/impl/LocationmapSourceFactory.java

[thorsten]

Author: thorsten
Date: Tue May  6 02:44:14 2008
New Revision: 653724

URL: http://svn.apache.org/viewvc?rev=653724&view=rev
Log:
Adding javadoc.

Modified:
    forrest/trunk/main/java/org/apache/forrest/locationmap/lm/MountNode.java
    
forrest/trunk/main/java/org/apache/forrest/locationmap/source/impl/LocationmapSourceFactory.java

Modified: 
forrest/trunk/main/java/org/apache/forrest/locationmap/lm/MountNode.java
URL: 
http://svn.apache.org/viewvc/forrest/trunk/main/java/org/apache/forrest/locationmap/lm/MountNode.java?rev=653724&r1=653723&r2=653724&view=diff
==============================================================================
--- forrest/trunk/main/java/org/apache/forrest/locationmap/lm/MountNode.java 
(original)
+++ forrest/trunk/main/java/org/apache/forrest/locationmap/lm/MountNode.java 
Tue May  6 02:44:14 2008
@@ -29,7 +29,6 @@
 import 
org.apache.cocoon.components.treeprocessor.variables.VariableResolverFactory;
 import org.apache.cocoon.sitemap.PatternException;
 import org.apache.excalibur.source.SourceValidity;
-import org.apache.excalibur.source.SourceUtil;
 import org.apache.excalibur.source.SourceResolver;
 import org.apache.excalibur.source.Source;
 import org.apache.excalibur.xml.sax.SAXParser;
@@ -38,6 +37,12 @@
 
 /**
  * locationmap mount statement.
+ * <p>
+ * The &lt;mount&gt; element has one required <code>src</code> attribute
+ * that contains the location string of the sub locationmap that should
+ * be mounted.
+ * </p>
+ * 
  */
 public class MountNode extends AbstractNode {
 

Modified: 
forrest/trunk/main/java/org/apache/forrest/locationmap/source/impl/LocationmapSourceFactory.java
URL: 
http://svn.apache.org/viewvc/forrest/trunk/main/java/org/apache/forrest/locationmap/source/impl/LocationmapSourceFactory.java?rev=653724&r1=653723&r2=653724&view=diff
==============================================================================
--- 
forrest/trunk/main/java/org/apache/forrest/locationmap/source/impl/LocationmapSourceFactory.java
 (original)
+++ 
forrest/trunk/main/java/org/apache/forrest/locationmap/source/impl/LocationmapSourceFactory.java
 Tue May  6 02:44:14 2008
@@ -37,6 +37,13 @@
 import org.apache.excalibur.source.SourceException;
 import org.apache.excalibur.source.SourceFactory;
 
+/**
+ * A <code>Source</code> that takes its content from the 
+ * locationmap module.
+ * <p>The URI syntax is "lm//:<location>",
+ * where the location is any given String that 
+ * will be match by the locationmap module.
+ */
 public class LocationmapSourceFactory extends AbstractLogEnabled implements
         Serviceable, SourceFactory, ThreadSafe, Contextualizable {