You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by he...@apache.org on 2006/09/17 22:07:32 UTC

svn commit: r447133 [2/2] - in /jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime: log/ parser/ parser/node/ resource/ resource/loader/ visitor/

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/SimpleNode.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/SimpleNode.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/SimpleNode.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/parser/node/SimpleNode.java Sun Sep 17 13:07:29 2006
@@ -32,68 +32,121 @@
 import org.apache.velocity.runtime.parser.Token;
 
 
+/**
+ *
+ */
 public class SimpleNode implements Node
 {
+    /** */
     protected RuntimeServices rsvc = null;
+
+    /** */
     protected Log log = null;
 
+    /** */
     protected Node parent;
+
+    /** */
     protected Node[] children;
-    protected int id;
-    protected Parser parser;
     
+    /** */
+    protected int id;
+
+    /** */
+    protected Parser parser;    
+
+    /** */
     protected int info; // added
+
+    /** */
     public boolean state;
+
+    /** */
     protected boolean invalid = false;
     
-    /* Added */
-    protected Token first, last;
+    /** */
+    protected Token first;
+    
+    /** */
+    protected Token last;
 
+    /**
+     * @param i
+     */
     public SimpleNode(int i)
     {
         id = i;
     }
 
+    /**
+     * @param p
+     * @param i
+     */
     public SimpleNode(Parser p, int i)
     {
         this(i);
         parser = p;
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#jjtOpen()
+     */
     public void jjtOpen()
     {
         first = parser.getToken(1); // added
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#jjtClose()
+     */
     public void jjtClose()
     {
         last = parser.getToken(0); // added
     }
 
+    /**
+     * @param t
+     */
     public void setFirstToken(Token t)
     {
         this.first = t;
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#getFirstToken()
+     */
     public Token getFirstToken()
     {
         return first;
     }
+
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#getLastToken()
+     */
     public Token getLastToken()
     {
         return last;
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#jjtSetParent(org.apache.velocity.runtime.parser.node.Node)
+     */
     public void jjtSetParent(Node n)
     {
         parent = n;
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#jjtGetParent()
+     */
     public Node jjtGetParent()
     {
         return parent;
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#jjtAddChild(org.apache.velocity.runtime.parser.node.Node, int)
+     */
     public void jjtAddChild(Node n, int i)
     {
         if (children == null)
@@ -109,23 +162,35 @@
         children[i] = n;
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#jjtGetChild(int)
+     */
     public Node jjtGetChild(int i)
     {
         return children[i];
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#jjtGetNumChildren()
+     */
     public int jjtGetNumChildren()
     {
         return (children == null) ? 0 : children.length;
     }
 
-    /** Accept the visitor. **/
+
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#jjtAccept(org.apache.velocity.runtime.parser.ParserVisitor, java.lang.Object)
+     */
     public Object jjtAccept(ParserVisitor visitor, Object data)
     {
         return visitor.visit(this, data);
     }
 
-    /** Accept the visitor. **/
+
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#childrenAccept(org.apache.velocity.runtime.parser.ParserVisitor, java.lang.Object)
+     */
     public Object childrenAccept(ParserVisitor visitor, Object data)
     {
         if (children != null)
@@ -148,14 +213,21 @@
     // {
     //    return ParserTreeConstants.jjtNodeName[id];
     // }
+    /**
+     * @param prefix
+     * @return String representation of this node.
+     */
     public String toString(String prefix)
     {
         return prefix + toString();
     }
 
-    /* Override this method if you want to customize how the node dumps
-        out its children. */
-
+    /**
+     * Override this method if you want to customize how the node dumps
+     * out its children. 
+     *  
+     * @param prefix 
+     */
     public void dump(String prefix)
     {
         System.out.println(toString(prefix));
@@ -174,6 +246,9 @@
 
     // All additional methods
 
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#literal()
+     */
     public String literal()
     {
         Token t = first;
@@ -188,6 +263,9 @@
         return sb.toString();
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#init(org.apache.velocity.context.InternalContextAdapter, java.lang.Object)
+     */
     public Object init( InternalContextAdapter context, Object data) throws Exception
     {
         /*
@@ -214,18 +292,27 @@
         return data;
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#evaluate(org.apache.velocity.context.InternalContextAdapter)
+     */
     public boolean evaluate( InternalContextAdapter  context)
         throws MethodInvocationException
     {
         return false;
     }        
 
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#value(org.apache.velocity.context.InternalContextAdapter)
+     */
     public Object value( InternalContextAdapter context)
         throws MethodInvocationException
     {
         return null;
     }        
 
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#render(org.apache.velocity.context.InternalContextAdapter, java.io.Writer)
+     */
     public boolean render( InternalContextAdapter context, Writer writer)
         throws IOException, MethodInvocationException, ParseErrorException, ResourceNotFoundException
     {
@@ -237,42 +324,66 @@
         return true;
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#execute(java.lang.Object, org.apache.velocity.context.InternalContextAdapter)
+     */
     public Object execute(Object o, InternalContextAdapter context)
       throws MethodInvocationException
     {
         return null;
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#getType()
+     */
     public int getType()
     {
         return id;
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#setInfo(int)
+     */
     public void setInfo(int info)
     {
         this.info = info;
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#getInfo()
+     */
     public int getInfo()
     {
         return info;
     }        
 
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#setInvalid()
+     */
     public void setInvalid()
     {
         invalid = true;
     }        
 
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#isInvalid()
+     */
     public boolean isInvalid()
     {
         return invalid;
     }        
 
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#getLine()
+     */
     public int getLine()
     {
         return first.beginLine;
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.node.Node#getColumn()
+     */
     public int getColumn()
     {
         return first.beginColumn;

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ContentResource.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ContentResource.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ContentResource.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ContentResource.java Sun Sep 17 13:07:29 2006
@@ -42,6 +42,7 @@
     
     /**
      * Pull in static content and store it.
+     * @return True if everything went ok.
      *
      * @exception ResourceNotFoundException Resource could not be
      * found.

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/Resource.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/Resource.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/Resource.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/Resource.java Sun Sep 17 13:07:29 2006
@@ -88,6 +88,9 @@
     {
     }
 
+    /**
+     * @param rs
+     */
     public void setRuntimeServices( RuntimeServices rs )
     {
         rsvc = rs;
@@ -105,10 +108,15 @@
      * indicates whether the resource could be read.
      * @exception ResourceNotFoundException Similar in semantics as
      * returning <code>false</code>.
+     * @throws ParseErrorException 
+     * @throws Exception 
      */
     public abstract boolean process() 
         throws ResourceNotFoundException, ParseErrorException, Exception;
 
+    /**
+     * @return True if source has been modified.
+     */
     public boolean isSourceModified()
     {
         return resourceLoader.isSourceModified(this);
@@ -126,6 +134,7 @@
     /**
      * Is it time to check to see if the resource
      * source has been updated?
+     * @return True if resource must be checked.
      */
     public boolean requiresChecking()
     {
@@ -158,6 +167,7 @@
     /**
      * Set the name of this resource, for example
      * test.vm.
+     * @param name 
      */
     public void setName(String name)
     {
@@ -166,6 +176,7 @@
 
     /**
      * Get the name of this template.
+     * @return The name of this template.
      */
     public String getName()
     {
@@ -175,6 +186,7 @@
     /**
      *  set the encoding of this resource
      *  for example, "ISO-8859-1"
+     * @param encoding 
      */
     public void setEncoding( String encoding )
     {
@@ -184,6 +196,7 @@
     /**
      *  get the encoding of this resource
      *  for example, "ISO-8859-1"
+     * @return The encoding of this resource.
      */
     public String getEncoding()
     {
@@ -193,7 +206,8 @@
 
     /**
      * Return the lastModifed time of this
-     * template.
+     * resource.
+     * @return The lastModifed time of this resource.
      */
     public long getLastModified()
     {
@@ -202,7 +216,8 @@
     
     /**
      * Set the last modified time for this
-     * template.
+     * resource.
+     * @param lastModified 
      */
     public void setLastModified(long lastModified)
     {
@@ -212,6 +227,7 @@
     /**
      * Return the template loader that pulled
      * in the template stream
+     * @return The resource loader for this resource.
      */
     public ResourceLoader getResourceLoader()
     {
@@ -222,6 +238,7 @@
      * Set the template loader for this template. Set
      * when the Runtime determines where this template
      * came from the list of possible sources.
+     * @param resourceLoader 
      */
     public void setResourceLoader(ResourceLoader resourceLoader)
     {
@@ -231,6 +248,7 @@
     /** 
      * Set arbitrary data object that might be used
      * by the resource.
+     * @param data 
      */
     public void setData(Object data)
     {
@@ -240,6 +258,7 @@
     /**
      * Get arbitrary data object that might be used
      * by the resource.
+     * @return The data object for this resource.
      */
     public Object getData()
     {

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceCache.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceCache.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceCache.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceCache.java Sun Sep 17 13:07:29 2006
@@ -58,12 +58,13 @@
      *  removes a Resource from the cache
      *
      *  @param resourceKey resource to be removed
-     *  @param Resource stored under key
+     *  @return stored under key
      */
     public Resource remove( Object resourceKey );
     
     /**
-     *  returns an Iterator of Keys in the cache
+     *  returns an Iterator of Keys in the cache.
+     * @return An Iterator of Keys in the cache.
      */
      public Iterator enumerateKeys();
 }

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceCacheImpl.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceCacheImpl.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceCacheImpl.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceCacheImpl.java Sun Sep 17 13:07:29 2006
@@ -31,7 +31,7 @@
  * algorithm, with a maximum size specified via the
  * <code>resource.manager.cache.size</code> property (idenfied by the
  * {@link
- * org.apache.velocity.runtime.RuntimeConstants#RESOURCE_MANAGER_CACHE_SIZE}
+ * org.apache.velocity.runtime.RuntimeConstants#RESOURCE_MANAGER_DEFAULTCACHE_SIZE}
  * constant).  This property get be set to <code>0</code> or less for
  * a greedy, unbounded cache (the behavior from pre-v1.5).
  *
@@ -52,6 +52,9 @@
      */
     protected RuntimeServices rsvc = null;
     
+    /**
+     * @see org.apache.velocity.runtime.resource.ResourceCache#initialize(org.apache.velocity.runtime.RuntimeServices)
+     */
     public void initialize( RuntimeServices rs )
     {
         rsvc = rs;
@@ -69,21 +72,33 @@
         rsvc.getLog().debug("ResourceCache: initialized ("+this.getClass()+')');
     }
     
+    /**
+     * @see org.apache.velocity.runtime.resource.ResourceCache#get(java.lang.Object)
+     */
     public Resource get( Object key )
     {
         return (Resource) cache.get( key );
     }
     
+    /**
+     * @see org.apache.velocity.runtime.resource.ResourceCache#put(java.lang.Object, org.apache.velocity.runtime.resource.Resource)
+     */
     public Resource put( Object key, Resource value )
     {
         return (Resource) cache.put( key, value );
     }
     
+    /**
+     * @see org.apache.velocity.runtime.resource.ResourceCache#remove(java.lang.Object)
+     */
     public Resource remove( Object key )
     {
         return (Resource) cache.remove( key );
     }
     
+    /**
+     * @see org.apache.velocity.runtime.resource.ResourceCache#enumerateKeys()
+     */
     public Iterator enumerateKeys()
     {
         return cache.keySet().iterator();

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceFactory.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceFactory.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceFactory.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceFactory.java Sun Sep 17 13:07:29 2006
@@ -28,6 +28,11 @@
  */
 public class ResourceFactory
 {
+    /**
+     * @param resourceName
+     * @param resourceType
+     * @return The resource described by name and type.
+     */
     public static Resource getResource(String resourceName, int resourceType)
     {
         Resource resource = null;

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceManager.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceManager.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceManager.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceManager.java Sun Sep 17 13:07:29 2006
@@ -44,6 +44,8 @@
 
     /**
      * Initialize the ResourceManager.
+     * @param rs 
+     * @throws Exception 
      */
     public void initialize( RuntimeServices rs ) throws Exception;
 

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceManagerImpl.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceManagerImpl.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceManagerImpl.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/ResourceManagerImpl.java Sun Sep 17 13:07:29 2006
@@ -100,6 +100,8 @@
 
     /**
      * Initialize the ResourceManager.
+     * @param rs 
+     * @throws Exception 
      */
     public void initialize( RuntimeServices rs ) 
         throws Exception

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/ClasspathResourceLoader.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/ClasspathResourceLoader.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/ClasspathResourceLoader.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/ClasspathResourceLoader.java Sun Sep 17 13:07:29 2006
@@ -77,6 +77,7 @@
 
     /**
      *  This is abstract in the base class, so we need it
+     * @param configuration 
      */
     public void init( ExtendedProperties configuration)
     {
@@ -131,7 +132,7 @@
     }
 
     /**
-     * Defaults to return false.
+     * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#isSourceModified(org.apache.velocity.runtime.resource.Resource)
      */
     public boolean isSourceModified(Resource resource)
     {
@@ -139,7 +140,7 @@
     }
 
     /**
-     * Defaults to return 0
+     * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#getLastModified(org.apache.velocity.runtime.resource.Resource)
      */
     public long getLastModified(Resource resource)
     {

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/DataSourceResourceLoader.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/DataSourceResourceLoader.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/DataSourceResourceLoader.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/DataSourceResourceLoader.java Sun Sep 17 13:07:29 2006
@@ -132,7 +132,10 @@
      private InitialContext ctx;
      private DataSource dataSource;
 
-     public void init(ExtendedProperties configuration)
+     /**
+      * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#init(org.apache.commons.collections.ExtendedProperties)
+      */
+    public void init(ExtendedProperties configuration)
      {
          dataSourceName  = StringUtils.nullTrim(configuration.getString("resource.datasource"));
          tableName       = StringUtils.nullTrim(configuration.getString("resource.table"));
@@ -175,20 +178,26 @@
     /**
      * Set the DataSource used by this resource loader.  Call this as an alternative to 
      * specifying the data source name via properties.
-     * @param source
+     * @param dataSource The data source for this ResourceLoader. 
      */
     public void setDataSource(final DataSource dataSource) 
     {
         this.dataSource = dataSource;
     }
 
-     public boolean isSourceModified(final Resource resource)
+     /**
+     * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#isSourceModified(org.apache.velocity.runtime.resource.Resource)
+     */
+    public boolean isSourceModified(final Resource resource)
      {
          return (resource.getLastModified() !=
                  readLastModified(resource, "checking timestamp"));
      }
 
-     public long getLastModified(final Resource resource)
+     /**
+     * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#getLastModified(org.apache.velocity.runtime.resource.Resource)
+     */
+    public long getLastModified(final Resource resource)
      {
          return readLastModified(resource, "getting timestamp");
      }
@@ -199,6 +208,7 @@
       *
       *  @param name name of template
       *  @return InputStream containing template
+     * @throws ResourceNotFoundException 
       */
      public synchronized InputStream getResourceStream(final String name)
          throws ResourceNotFoundException

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/FileResourceLoader.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/FileResourceLoader.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/FileResourceLoader.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/FileResourceLoader.java Sun Sep 17 13:07:29 2006
@@ -59,6 +59,9 @@
      */
     private Map templatePaths = Collections.synchronizedMap(new HashMap());
 
+    /**
+     * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#init(org.apache.commons.collections.ExtendedProperties)
+     */
     public void init( ExtendedProperties configuration)
     {
         if (log.isTraceEnabled())
@@ -186,6 +189,8 @@
      * path; so we should search the path and see if
      * the file we find that way is the same as the one
      * that we have cached.
+     * @param resource 
+     * @return True if the source has been modified.
      */
     public boolean isSourceModified(Resource resource)
     {
@@ -238,6 +243,9 @@
         return modified;
     }
 
+    /**
+     * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#getLastModified(org.apache.velocity.runtime.resource.Resource)
+     */
     public long getLastModified(Resource resource)
     {
         String path = (String) templatePaths.get(resource.getName());

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/JarHolder.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/JarHolder.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/JarHolder.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/JarHolder.java Sun Sep 17 13:07:29 2006
@@ -43,6 +43,10 @@
         
     private Log log = null;
 
+    /**
+     * @param rs
+     * @param urlpath
+     */
     public JarHolder( RuntimeServices rs, String urlpath )
     {
         this.log = rs.getLog();
@@ -56,6 +60,9 @@
         }
     }
 
+    /**
+     * 
+     */
     public void init()
     {
         try
@@ -79,6 +86,9 @@
         }
     }
 
+    /**
+     * 
+     */
     public void close() 
     {
         try
@@ -95,6 +105,11 @@
         log.trace("JarHolder: JAR file closed");
     }
     
+    /**
+     * @param theentry
+     * @return The requested resource.
+     * @throws ResourceNotFoundException
+     */
     public InputStream getResource( String theentry )
      throws ResourceNotFoundException {
         InputStream data = null;
@@ -117,6 +132,9 @@
         return data;
     }
 
+    /**
+     * @return The entries of the jar as a hashtable.
+     */
     public Hashtable getEntries()
     {
         Hashtable allEntries = new Hashtable(559);
@@ -135,6 +153,9 @@
         return allEntries;
     }
     
+    /**
+     * @return The URL path of this jar holder.
+     */
     public String getUrlPath()
     {
         return urlpath;

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/JarResourceLoader.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/JarResourceLoader.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/JarResourceLoader.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/JarResourceLoader.java Sun Sep 17 13:07:29 2006
@@ -77,6 +77,7 @@
    
     /**
      * Called by Velocity to initialize the loader
+     * @param configuration 
      */
     public void init( ExtendedProperties configuration)
     {
@@ -178,7 +179,7 @@
      * Get an InputStream so that the Runtime can build a
      * template with it.
      *
-     * @param name name of template to get
+     * @param source name of template to get
      * @return InputStream containing the template
      * @throws ResourceNotFoundException if template not found
      *         in the file template path.
@@ -232,13 +233,19 @@
     }
         
         
-    // TO DO BELOW 
-    // SHOULD BE DELEGATED TO THE JARHOLDER
+    // TODO: SHOULD BE DELEGATED TO THE JARHOLDER
+
+    /**
+     * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#isSourceModified(org.apache.velocity.runtime.resource.Resource)
+     */
     public boolean isSourceModified(Resource resource)
     {
         return true;
     }
 
+    /**
+     * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#getLastModified(org.apache.velocity.runtime.resource.Resource)
+     */
     public long getLastModified(Resource resource)
     {
         return 0;

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/ResourceLoader.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/ResourceLoader.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/ResourceLoader.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/ResourceLoader.java Sun Sep 17 13:07:29 2006
@@ -62,6 +62,8 @@
      * This initialization is used by all resource
      * loaders and must be called to set up common
      * properties shared by all resource loaders
+     * @param rs 
+     * @param configuration 
      */
     public void commonInit( RuntimeServices rs, ExtendedProperties configuration)
     {
@@ -113,12 +115,16 @@
     /**
      * Initialize the template loader with a
      * a resources class.
+     * @param configuration 
      */
     public abstract void init( ExtendedProperties configuration);
 
     /**
      * Get the InputStream that the Runtime will parse
      * to create a template.
+     * @param source 
+     * @return The input stream for the requested resource.
+     * @throws ResourceNotFoundException 
      */
     public abstract InputStream getResourceStream( String source )
         throws ResourceNotFoundException;
@@ -126,6 +132,8 @@
     /**
      * Given a template, check to see if the source of InputStream
      * has been modified.
+     * @param resource 
+     * @return True if the resource has been modified.
      */
     public abstract boolean isSourceModified(Resource resource);
 
@@ -134,11 +142,14 @@
      * that was used to create the template. We need the template
      * here because we have to extract the name of the template
      * in order to locate the InputStream source.
+     * @param resource 
+     * @return Time in millis when the resource has been modified.
      */
     public abstract long getLastModified(Resource resource);
 
     /**
      * Return the class name of this resource Loader
+     * @return Class name of the resource loader.
      */
     public String getClassName()
     {
@@ -150,6 +161,7 @@
      * would like the Runtime to cache templates that
      * have been created with InputStreams provided
      * by this loader.
+     * @param value 
      */
     public void setCachingOn(boolean value)
     {
@@ -161,6 +173,7 @@
      * template loader wants the Runtime to cache
      * templates created with InputStreams provided
      * by this loader.
+     * @return True if this resource loader caches.
      */
     public boolean isCachingOn()
     {
@@ -170,6 +183,7 @@
     /**
      * Set the interval at which the InputStream source
      * should be checked for modifications.
+     * @param modificationCheckInterval 
      */
     public void setModificationCheckInterval(long modificationCheckInterval)
     {
@@ -179,6 +193,7 @@
     /**
      * Get the interval at which the InputStream source
      * should be checked for modifications.
+     * @return The modification check interval.
      */
     public long getModificationCheckInterval()
     {

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/ResourceLoaderFactory.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/ResourceLoaderFactory.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/ResourceLoaderFactory.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/ResourceLoaderFactory.java Sun Sep 17 13:07:29 2006
@@ -30,7 +30,10 @@
 {
     /**
      * Gets the loader specified in the configuration file.
+     * @param rs 
+     * @param loaderClassName 
      * @return TemplateLoader
+     * @throws Exception 
      */
     public static ResourceLoader getLoader(RuntimeServices rs, String loaderClassName)
      throws Exception

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/URLResourceLoader.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/URLResourceLoader.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/URLResourceLoader.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/resource/loader/URLResourceLoader.java Sun Sep 17 13:07:29 2006
@@ -38,6 +38,9 @@
     private String[] roots = null;
     protected HashMap templateRoots = null;
 
+    /**
+     * @see org.apache.velocity.runtime.resource.loader.ResourceLoader#init(org.apache.commons.collections.ExtendedProperties)
+     */
     public void init(ExtendedProperties configuration)
     {
         log.trace("URLResourceLoader : initialization starting.");

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/visitor/BaseVisitor.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/visitor/BaseVisitor.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/visitor/BaseVisitor.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/visitor/BaseVisitor.java Sun Sep 17 13:07:29 2006
@@ -79,256 +79,385 @@
     /** Writer used as the output sink */
     protected Writer writer;
     
+    /**
+     * @param writer
+     */
     public void setWriter( Writer writer )
     {
         this.writer = writer;
     }        
 
+    /**
+     * @param context
+     */
     public void setContext( InternalContextAdapter context)
     {
         this.context = context;
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.SimpleNode, java.lang.Object)
+     */
     public Object visit(SimpleNode node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTprocess, java.lang.Object)
+     */
     public Object visit(ASTprocess node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTExpression, java.lang.Object)
+     */
     public Object visit(ASTExpression node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTAssignment, java.lang.Object)
+     */
     public Object visit(ASTAssignment node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTOrNode, java.lang.Object)
+     */
     public Object visit(ASTOrNode node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTAndNode, java.lang.Object)
+     */
     public Object visit(ASTAndNode node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTEQNode, java.lang.Object)
+     */
     public Object visit(ASTEQNode node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTNENode, java.lang.Object)
+     */
     public Object visit(ASTNENode node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTLTNode, java.lang.Object)
+     */
     public Object visit(ASTLTNode node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTGTNode, java.lang.Object)
+     */
     public Object visit(ASTGTNode node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTLENode, java.lang.Object)
+     */
     public Object visit(ASTLENode node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTGENode, java.lang.Object)
+     */
     public Object visit(ASTGENode node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTAddNode, java.lang.Object)
+     */
     public Object visit(ASTAddNode node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTSubtractNode, java.lang.Object)
+     */
     public Object visit(ASTSubtractNode node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTMulNode, java.lang.Object)
+     */
     public Object visit(ASTMulNode node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTDivNode, java.lang.Object)
+     */
     public Object visit(ASTDivNode node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTModNode, java.lang.Object)
+     */
     public Object visit(ASTModNode node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTNotNode, java.lang.Object)
+     */
     public Object visit(ASTNotNode node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTIntegerLiteral, java.lang.Object)
+     */
     public Object visit(ASTIntegerLiteral node, Object data)
     {
         data = node.childrenAccept(this, data);
         return data;
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTFloatingPointLiteral, java.lang.Object)
+     */
     public Object visit(ASTFloatingPointLiteral node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTStringLiteral, java.lang.Object)
+     */
     public Object visit(ASTStringLiteral node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTIdentifier, java.lang.Object)
+     */
     public Object visit(ASTIdentifier node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTMethod, java.lang.Object)
+     */
     public Object visit(ASTMethod node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTReference, java.lang.Object)
+     */
     public Object visit(ASTReference node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTTrue, java.lang.Object)
+     */
     public Object visit(ASTTrue node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTFalse, java.lang.Object)
+     */
     public Object visit(ASTFalse node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTBlock, java.lang.Object)
+     */
     public Object visit(ASTBlock node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTText, java.lang.Object)
+     */
     public Object visit(ASTText node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTIfStatement, java.lang.Object)
+     */
     public Object visit(ASTIfStatement node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTElseStatement, java.lang.Object)
+     */
     public Object visit(ASTElseStatement node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTElseIfStatement, java.lang.Object)
+     */
     public Object visit(ASTElseIfStatement node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTComment, java.lang.Object)
+     */
     public Object visit(ASTComment node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTObjectArray, java.lang.Object)
+     */
     public Object visit(ASTObjectArray node, Object data)
     { 
         data = node.childrenAccept(this, data); 
         return data; 
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTWord, java.lang.Object)
+     */
     public Object visit(ASTWord node, Object data)
     { 
         data = node.childrenAccept(this, data);   
         return data;
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTSetDirective, java.lang.Object)
+     */
     public Object visit(ASTSetDirective node, Object data)
     { 
         data = node.childrenAccept(this, data);   
         return data;
     }
     
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTDirective, java.lang.Object)
+     */
     public Object visit(ASTDirective node, Object data)
     { 
         data = node.childrenAccept(this, data);   
         return data;
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTEscapedDirective, java.lang.Object)
+     */
     public Object visit(ASTEscapedDirective node, Object data)
     {
         data = node.childrenAccept(this, data);   
         return data;
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTEscape, java.lang.Object)
+     */
     public Object visit(ASTEscape node, Object data)
     {
         data = node.childrenAccept(this, data);   
         return data;
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTMap, java.lang.Object)
+     */
     public Object visit(ASTMap node, Object data)
     {
         data = node.childrenAccept(this, data);   
         return data;
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTIntegerRange, java.lang.Object)
+     */
     public Object visit(ASTIntegerRange node, Object data)
     {
         data = node.childrenAccept(this, data);   
         return data;
     }
 
+    /**
+     * @see org.apache.velocity.runtime.parser.ParserVisitor#visit(org.apache.velocity.runtime.parser.node.ASTStop, java.lang.Object)
+     */
     public Object visit(ASTStop node, Object data)
     {
         data = node.childrenAccept(this, data);   

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/visitor/NodeViewMode.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/visitor/NodeViewMode.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/visitor/NodeViewMode.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/visitor/NodeViewMode.java Sun Sep 17 13:07:29 2006
@@ -115,232 +115,321 @@
         return data;
     }
 
-    /** Display a SimpleNode */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.SimpleNode, java.lang.Object)
+     */
     public Object visit(SimpleNode node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTprocess node */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTprocess, java.lang.Object)
+     */
     public Object visit(ASTprocess node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTExpression node */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTExpression, java.lang.Object)
+     */
     public Object visit(ASTExpression node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTAssignment node ( = ) */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTAssignment, java.lang.Object)
+     */
     public Object visit(ASTAssignment node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTOrNode ( || ) */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTOrNode, java.lang.Object)
+     */
     public Object visit(ASTOrNode node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTAndNode ( && ) */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTAndNode, java.lang.Object)
+     */
     public Object visit(ASTAndNode node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTEQNode ( == ) */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTEQNode, java.lang.Object)
+     */
     public Object visit(ASTEQNode node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTNENode ( != ) */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTNENode, java.lang.Object)
+     */
     public Object visit(ASTNENode node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTLTNode ( < ) */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTLTNode, java.lang.Object)
+     */
     public Object visit(ASTLTNode node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTGTNode ( > ) */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTGTNode, java.lang.Object)
+     */
     public Object visit(ASTGTNode node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTLENode ( <= ) */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTLENode, java.lang.Object)
+     */
     public Object visit(ASTLENode node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTGENode ( >= ) */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTGENode, java.lang.Object)
+     */
     public Object visit(ASTGENode node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTAddNode ( + ) */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTAddNode, java.lang.Object)
+     */
     public Object visit(ASTAddNode node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTSubtractNode ( - ) */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTSubtractNode, java.lang.Object)
+     */
     public Object visit(ASTSubtractNode node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTMulNode ( * ) */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTMulNode, java.lang.Object)
+     */
     public Object visit(ASTMulNode node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTDivNode ( / ) */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTDivNode, java.lang.Object)
+     */
     public Object visit(ASTDivNode node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTModNode ( % ) */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTModNode, java.lang.Object)
+     */
     public Object visit(ASTModNode node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTNotNode ( ! ) */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTNotNode, java.lang.Object)
+     */
     public Object visit(ASTNotNode node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTFloatingPointLiteral node  */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTFloatingPointLiteral, java.lang.Object)
+     */
     public Object visit(ASTFloatingPointLiteral node, Object data)
     {
         return showNode(node,data);
     }
 
-    /** Display an ASTIntegerLiteral node  */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTIntegerLiteral, java.lang.Object)
+     */
     public Object visit(ASTIntegerLiteral node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTStringLiteral node */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTStringLiteral, java.lang.Object)
+     */
     public Object visit(ASTStringLiteral node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTIdentifier node */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTIdentifier, java.lang.Object)
+     */
     public Object visit(ASTIdentifier node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTMethod node */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTMethod, java.lang.Object)
+     */
     public Object visit(ASTMethod node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTReference node */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTReference, java.lang.Object)
+     */
     public Object visit(ASTReference node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTTrue node */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTTrue, java.lang.Object)
+     */
     public Object visit(ASTTrue node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTFalse node */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTFalse, java.lang.Object)
+     */
     public Object visit(ASTFalse node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTBlock node */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTBlock, java.lang.Object)
+     */
     public Object visit(ASTBlock node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTText node */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTText, java.lang.Object)
+     */
     public Object visit(ASTText node, Object data)
     { 
         return showNode(node,data); 
     }
     
-    /** Display an ASTIfStatement node */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTIfStatement, java.lang.Object)
+     */
     public Object visit(ASTIfStatement node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTElseStatement node */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTElseStatement, java.lang.Object)
+     */
     public Object visit(ASTElseStatement node, Object data)
     { 
         return showNode(node,data);
     }
     
-    /** Display an ASTElseIfStatement node */
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTElseIfStatement, java.lang.Object)
+     */
     public Object visit(ASTElseIfStatement node, Object data)
     { 
         return showNode(node,data);
     }
     
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTObjectArray, java.lang.Object)
+     */
     public Object visit(ASTObjectArray node, Object data)
     { 
         return showNode(node,data);
     }
 
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTDirective, java.lang.Object)
+     */
     public Object visit(ASTDirective node, Object data)
     { 
         return showNode(node,data);
     }
 
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTWord, java.lang.Object)
+     */
     public Object visit(ASTWord node, Object data)
     { 
         return showNode(node,data);
     }
     
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTSetDirective, java.lang.Object)
+     */
     public Object visit(ASTSetDirective node, Object data)
     { 
         return showNode(node,data);
     }
 
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTEscapedDirective, java.lang.Object)
+     */
     public Object visit(ASTEscapedDirective node, Object data)
     {
         return showNode(node,data);
     }
 
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTEscape, java.lang.Object)
+     */
     public Object visit(ASTEscape node, Object data)
     {
         return showNode(node,data);
     }
 
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTMap, java.lang.Object)
+     */
     public Object visit(ASTMap node, Object data)
     {
         return showNode(node,data);
     }
 
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTIntegerRange, java.lang.Object)
+     */
     public Object visit(ASTIntegerRange node, Object data)
     {
         return showNode(node,data);
     }
 
+    /**
+     * @see org.apache.velocity.runtime.visitor.BaseVisitor#visit(org.apache.velocity.runtime.parser.node.ASTStop, java.lang.Object)
+     */
     public Object visit(ASTStop node, Object data)
     {
         return showNode(node,data);

Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/visitor/VMReferenceMungeVisitor.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/visitor/VMReferenceMungeVisitor.java?view=diff&rev=447133&r1=447132&r2=447133
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/visitor/VMReferenceMungeVisitor.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/visitor/VMReferenceMungeVisitor.java Sun Sep 17 13:07:29 2006
@@ -39,6 +39,7 @@
 
     /**
      *  CTOR - takes a map of args to reference
+     * @param map 
      */
     public VMReferenceMungeVisitor( Map map )
     {
@@ -51,6 +52,7 @@
      *
      *  @param node ASTReference to work on
      *  @param data Object to pass down from caller
+     * @return A visitor object result.
      */
     public Object visit( ASTReference node, Object data)
     {



---------------------------------------------------------------------
To unsubscribe, e-mail: velocity-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: velocity-dev-help@jakarta.apache.org