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 20:27:14 UTC
svn commit: r447106 - in
/jakarta/velocity/engine/trunk/src/java/org/apache/velocity: ./ anakia/
app/ app/event/ app/event/implement/ app/tools/ runtime/
Author: henning
Date: Sun Sep 17 11:27:13 2006
New Revision: 447106
URL: http://svn.apache.org/viewvc?view=rev&rev=447106
Log:
More javadoc fixes.
Modified:
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/VelocityContext.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/AnakiaJDOMFactory.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/AnakiaTask.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/Escape.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/NodeList.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/OutputWrapper.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/TreeWalker.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/XPathTool.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/FieldMethodizer.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/VelocityEngine.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/ContextAware.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventCartridge.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/ReferenceInsertionEventHandler.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/RuntimeServicesAware.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeHtmlReference.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeJavaScriptReference.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeReference.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeSqlReference.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeXmlReference.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/IncludeNotFound.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/IncludeRelativePath.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/PrintExceptions.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/tools/VelocityFormatter.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/ParserPool.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/ParserPoolImpl.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeConstants.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeLogger.java
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/VelocityContext.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/VelocityContext.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/VelocityContext.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/VelocityContext.java Sun Sep 17 11:27:13 2006
@@ -68,6 +68,7 @@
/**
* Creates a new instance with the provided storage (and no inner
* context).
+ * @param context
*/
public VelocityContext(Map context)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/AnakiaJDOMFactory.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/AnakiaJDOMFactory.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/AnakiaJDOMFactory.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/AnakiaJDOMFactory.java Sun Sep 17 11:27:13 2006
@@ -29,25 +29,40 @@
*/
public class AnakiaJDOMFactory extends DefaultJDOMFactory
{
+ /**
+ *
+ */
public AnakiaJDOMFactory()
{
}
+ /**
+ * @see org.jdom.DefaultJDOMFactory#element(java.lang.String, org.jdom.Namespace)
+ */
public Element element(String name, Namespace namespace)
{
return new AnakiaElement(name, namespace);
}
+ /**
+ * @see org.jdom.DefaultJDOMFactory#element(java.lang.String)
+ */
public Element element(String name)
{
return new AnakiaElement(name);
}
+ /**
+ * @see org.jdom.DefaultJDOMFactory#element(java.lang.String, java.lang.String)
+ */
public Element element(String name, String uri)
{
return new AnakiaElement(name, uri);
}
+ /**
+ * @see org.jdom.DefaultJDOMFactory#element(java.lang.String, java.lang.String, java.lang.String)
+ */
public Element element(String name, String prefix, String uri)
{
return new AnakiaElement(name, prefix, uri);
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/AnakiaTask.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/AnakiaTask.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/AnakiaTask.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/AnakiaTask.java Sun Sep 17 11:27:13 2006
@@ -114,6 +114,7 @@
/**
* Set the base directory.
+ * @param dir
*/
public void setBasedir(File dir)
{
@@ -123,7 +124,7 @@
/**
* Set the destination directory into which the VSL result
* files should be copied to
- * @param dirName the name of the destination directory
+ * @param dir the name of the destination directory
*/
public void setDestdir(File dir)
{
@@ -132,6 +133,7 @@
/**
* Allow people to set the default output file extension
+ * @param extension
*/
public void setExtension(String extension)
{
@@ -140,6 +142,7 @@
/**
* Allow people to set the path to the .vsl file
+ * @param style
*/
public void setStyle(String style)
{
@@ -148,6 +151,7 @@
/**
* Allow people to set the path to the project.xml file
+ * @param projectAttribute
*/
public void setProjectFile(String projectAttribute)
{
@@ -162,6 +166,7 @@
* Velocity.properties file. This allows one to not have to define
* a Velocity.properties file, therefore using Velocity's defaults
* only.
+ * @param templatePath
*/
public void setTemplatePath(File templatePath)
@@ -182,6 +187,7 @@
* For example, if build.sh was executed in the ./build directory,
* then the path would be relative to this directory.
* This is optional based on the setting of setTemplatePath().
+ * @param velocityPropertiesFile
*/
public void setVelocityPropertiesFile(File velocityPropertiesFile)
{
@@ -190,6 +196,7 @@
/**
* Turn on/off last modified checking. by default, it is on.
+ * @param lastmod
*/
public void setLastModifiedCheck(String lastmod)
{
@@ -202,6 +209,7 @@
/**
* Main body of the application
+ * @throws BuildException
*/
public void execute () throws BuildException
{
@@ -529,6 +537,7 @@
/**
* Create a new context.
+ * @return A new context.
*/
public Context createContext()
{
@@ -557,6 +566,7 @@
/**
* Get the name of the context.
+ * @return The name of the context.
*/
public String getName()
{
@@ -565,6 +575,7 @@
/**
* Set the name of the context.
+ * @param name
*
* @throws IllegalArgumentException if a reserved word is used as a
* name, specifically any of "relativePath", "treeWalk", "xpath",
@@ -589,6 +600,7 @@
/**
* Build the context based on a file path.
+ * @param file
*/
public void setFile(String file)
{
@@ -597,6 +609,7 @@
/**
* Retrieve the time the source file was last modified.
+ * @return The time the source file was last modified.
*/
public long getLastModified()
{
@@ -605,6 +618,7 @@
/**
* Retrieve the context document object.
+ * @return The context document object.
*/
public Document getContextDocument()
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/Escape.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/Escape.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/Escape.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/Escape.java Sun Sep 17 11:27:13 2006
@@ -28,6 +28,9 @@
*/
public class Escape
{
+ /**
+ *
+ */
public static final String LINE_SEPARATOR = System.getProperty("line.separator");
/**
@@ -40,6 +43,8 @@
/**
* Do the escaping.
+ * @param st
+ * @return The escaped text.
*/
public static final String getText(String st)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/NodeList.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/NodeList.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/NodeList.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/NodeList.java Sun Sep 17 11:27:13 2006
@@ -55,6 +55,7 @@
/**
* Creates a node list that holds a single {@link Document} node.
+ * @param document
*/
public NodeList(Document document)
{
@@ -63,6 +64,7 @@
/**
* Creates a node list that holds a single {@link Element} node.
+ * @param element
*/
public NodeList(Element element)
{
@@ -114,6 +116,7 @@
* you can fully use the underlying list through the <code>List</code> interface
* of this class itself. You would probably access the underlying list only for
* synchronization purposes.
+ * @return The internal node List.
*/
public List getList()
{
@@ -127,6 +130,7 @@
* templates, as to output a node contained in variable x as XML fragment,
* you simply write ${x} in the template (or whatever your template engine
* uses as its expression syntax).
+ * @return The Nodelist as printable object.
*/
public String toString()
{
@@ -197,6 +201,7 @@
/**
* Returns a NodeList that contains the same nodes as this node list.
+ * @return A clone of this list.
* @throws CloneNotSupportedException if the contained list's class does
* not have an accessible no-arg constructor.
*/
@@ -235,6 +240,7 @@
/**
* Returns the hash code of the contained list.
+ * @return The hashcode of the list.
*/
public int hashCode()
{
@@ -264,7 +270,7 @@
* usually kept in the parsed template, this ensures that each XPath
* expression is parsed only once during the lifetime of the template that
* first invoked it.
- * @param xpathExpression the XPath expression you wish to apply
+ * @param xpathString the XPath expression you wish to apply
* @return a NodeList representing the nodes that are the result of
* application of the XPath to the current node list. It can be empty.
*/
@@ -275,116 +281,185 @@
// List methods implemented hereafter
+ /**
+ * @see java.util.List#add(java.lang.Object)
+ */
public boolean add(Object o)
{
return nodes.add(o);
}
+ /**
+ * @see java.util.List#add(int, java.lang.Object)
+ */
public void add(int index, Object o)
{
nodes.add(index, o);
}
+ /**
+ * @see java.util.List#addAll(java.util.Collection)
+ */
public boolean addAll(Collection c)
{
return nodes.addAll(c);
}
+ /**
+ * @see java.util.List#addAll(int, java.util.Collection)
+ */
public boolean addAll(int index, Collection c)
{
return nodes.addAll(index, c);
}
+ /**
+ * @see java.util.List#clear()
+ */
public void clear()
{
nodes.clear();
}
+ /**
+ * @see java.util.List#contains(java.lang.Object)
+ */
public boolean contains(Object o)
{
return nodes.contains(o);
}
+ /**
+ * @see java.util.List#containsAll(java.util.Collection)
+ */
public boolean containsAll(Collection c)
{
return nodes.containsAll(c);
}
+ /**
+ * @see java.util.List#get(int)
+ */
public Object get(int index)
{
return nodes.get(index);
}
+ /**
+ * @see java.util.List#indexOf(java.lang.Object)
+ */
public int indexOf(Object o)
{
return nodes.indexOf(o);
}
+ /**
+ * @see java.util.List#isEmpty()
+ */
public boolean isEmpty()
{
return nodes.isEmpty();
}
+ /**
+ * @see java.util.List#iterator()
+ */
public Iterator iterator()
{
return nodes.iterator();
}
+ /**
+ * @see java.util.List#lastIndexOf(java.lang.Object)
+ */
public int lastIndexOf(Object o)
{
return nodes.lastIndexOf(o);
}
+ /**
+ * @see java.util.List#listIterator()
+ */
public ListIterator listIterator()
{
return nodes.listIterator();
}
+ /**
+ * @see java.util.List#listIterator(int)
+ */
public ListIterator listIterator(int index)
{
return nodes.listIterator(index);
}
+ /**
+ * @see java.util.List#remove(int)
+ */
public Object remove(int index)
{
return nodes.remove(index);
}
+ /**
+ * @see java.util.List#remove(java.lang.Object)
+ */
public boolean remove(Object o)
{
return nodes.remove(o);
}
+ /**
+ * @see java.util.List#removeAll(java.util.Collection)
+ */
public boolean removeAll(Collection c)
{
return nodes.removeAll(c);
}
+ /**
+ * @see java.util.List#retainAll(java.util.Collection)
+ */
public boolean retainAll(Collection c)
{
return nodes.retainAll(c);
}
+ /**
+ * @see java.util.List#set(int, java.lang.Object)
+ */
public Object set(int index, Object o)
{
return nodes.set(index, o);
}
+ /**
+ * @see java.util.List#size()
+ */
public int size()
{
return nodes.size();
}
+ /**
+ * @see java.util.List#subList(int, int)
+ */
public List subList(int fromIndex, int toIndex)
{
return new NodeList(nodes.subList(fromIndex, toIndex));
}
+ /**
+ * @see java.util.List#toArray()
+ */
public Object[] toArray()
{
return nodes.toArray();
}
+ /**
+ * @see java.util.List#toArray(java.lang.Object[])
+ */
public Object[] toArray(Object[] a)
{
return nodes.toArray(a);
@@ -398,6 +473,11 @@
*/
private static final class AttributeXMLOutputter extends XMLOutputter
{
+ /**
+ * @param attribute
+ * @param out
+ * @throws IOException
+ */
public void output(Attribute attribute, Writer out)
throws IOException
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/OutputWrapper.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/OutputWrapper.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/OutputWrapper.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/OutputWrapper.java Sun Sep 17 11:27:13 2006
@@ -40,6 +40,9 @@
{
}
+ /**
+ * @param f
+ */
public OutputWrapper(Format f)
{
super(f);
@@ -56,6 +59,9 @@
* <p>
* foo <strong>bar</strong> ack </td>
* </p>
+ * @param element
+ * @param strip
+ * @return The output string.
*/
public String outputString(Element element, boolean strip)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/TreeWalker.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/TreeWalker.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/TreeWalker.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/TreeWalker.java Sun Sep 17 11:27:13 2006
@@ -48,7 +48,7 @@
/**
* Creates a new Vector and walks the Element tree.
*
- * @param Element the starting Element node
+ * @param e the starting Element node
* @return Vector a vector of Element nodes
*/
public NodeList allElements(Element e)
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/XPathTool.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/XPathTool.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/XPathTool.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/anakia/XPathTool.java Sun Sep 17 11:27:13 2006
@@ -97,7 +97,7 @@
* Apply an XPath to a JDOM Element
*
* @param xpathSpec The XPath to apply
- * @param doc The Element context
+ * @param elem The Element context
*
* @return A list of selected nodes
*/
@@ -112,7 +112,7 @@
* Apply an XPath to a nodeset
*
* @param xpathSpec The XPath to apply
- * @param doc The nodeset context
+ * @param nodeSet The nodeset context
*
* @return A list of selected nodes
*/
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/FieldMethodizer.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/FieldMethodizer.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/FieldMethodizer.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/FieldMethodizer.java Sun Sep 17 11:27:13 2006
@@ -99,7 +99,7 @@
* only methodized the public static fields of
* the class.
*
- * @param s Name of class to methodize.
+ * @param o Name of class to methodize.
*/
public FieldMethodizer( Object o )
{
@@ -117,6 +117,8 @@
/**
* Add the Name of the class to methodize
+ * @param s
+ * @throws Exception
*/
public void addObject ( String s )
throws Exception
@@ -126,6 +128,8 @@
/**
* Add an Object to methodize
+ * @param o
+ * @throws Exception
*/
public void addObject ( Object o )
throws Exception
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/VelocityEngine.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/VelocityEngine.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/VelocityEngine.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/VelocityEngine.java Sun Sep 17 11:27:13 2006
@@ -104,6 +104,7 @@
/**
* initialize the Velocity runtime engine, using the default
* properties of the Velocity distribution
+ * @throws Exception
*/
public void init()
throws Exception
@@ -117,6 +118,7 @@
*
* @param propsFilename file containing properties to use to initialize
* the Velocity runtime
+ * @throws Exception
*/
public void init(String propsFilename)
throws Exception
@@ -129,6 +131,7 @@
* plus the properties in the passed in java.util.Properties object
*
* @param p Proprties object containing initialization properties
+ * @throws Exception
*
*/
public void init(Properties p)
@@ -208,6 +211,10 @@
*
* @return true if successful, false otherwise. If false, see
* Velocity runtime log
+ * @throws ParseErrorException
+ * @throws MethodInvocationException
+ * @throws ResourceNotFoundException
+ * @throws IOException
*/
public boolean evaluate( Context context, Writer out,
String logTag, String instring )
@@ -230,6 +237,10 @@
*
* @return true if successful, false otherwise. If false, see
* Velocity runtime log
+ * @throws ParseErrorException
+ * @throws MethodInvocationException
+ * @throws ResourceNotFoundException
+ * @throws IOException
* @deprecated Use
* {@link #evaluate( Context context, Writer writer,
* String logTag, Reader reader ) }
@@ -273,6 +284,10 @@
*
* @return true if successful, false otherwise. If false, see
* Velocity runtime log
+ * @throws ParseErrorException
+ * @throws MethodInvocationException
+ * @throws ResourceNotFoundException
+ * @throws IOException
*
* @since Velocity v1.1
*/
@@ -353,6 +368,7 @@
* @param context Context object containing data/objects used for rendering.
* @param writer Writer for output stream
* @return true if Velocimacro exists and successfully invoked, false otherwise.
+ * @throws Exception
*/
public boolean invokeVelocimacro( String vmName, String logTag,
String params[], Context context,
@@ -430,6 +446,10 @@
*
* @return true if successful, false otherwise. Errors
* logged to velocity log.
+ * @throws ResourceNotFoundException
+ * @throws ParseErrorException
+ * @throws MethodInvocationException
+ * @throws Exception
* * @deprecated Use
* {@link #mergeTemplate( String templateName, String encoding,
* Context context, Writer writer )}
@@ -452,6 +472,10 @@
*
* @return true if successful, false otherwise. Errors
* logged to velocity log
+ * @throws ResourceNotFoundException
+ * @throws ParseErrorException
+ * @throws MethodInvocationException
+ * @throws Exception
*
* @since Velocity v1.1
*/
@@ -534,6 +558,8 @@
}
/**
+ * @param resourceName
+ * @return True if the template exists.
* @see #resourceExists(String)
* @deprecated Use resourceExists(String) instead.
*/
@@ -546,6 +572,7 @@
/**
* Returns a convenient Log instance that wraps the current LogChute.
* Use this to log error messages. It has the usual methods you'd expect.
+ * @return A log object.
*/
public Log getLog()
{
@@ -553,6 +580,7 @@
}
/**
+ * @param message
* @deprecated Use getLog() and call warn() on it.
*/
public void warn(Object message)
@@ -561,6 +589,7 @@
}
/**
+ * @param message
* @deprecated Use getLog() and call warn() on it.
*/
public void info(Object message)
@@ -569,6 +598,7 @@
}
/**
+ * @param message
* @deprecated Use getLog() and call warn() on it.
*/
public void error(Object message)
@@ -577,6 +607,7 @@
}
/**
+ * @param message
* @deprecated Use getLog() and call warn() on it.
*/
public void debug(Object message)
@@ -620,7 +651,7 @@
* </p>
*
* @param key object 'name' under which the object is stored
- * return value object to store under this key
+ * @return value object to store under this key
*/
public Object getApplicationAttribute( Object key )
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/ContextAware.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/ContextAware.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/ContextAware.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/ContextAware.java Sun Sep 17 11:27:13 2006
@@ -37,6 +37,7 @@
{
/**
* Initialize the EventHandler.
+ * @param context
*/
public void setContext( Context context );
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventCartridge.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventCartridge.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventCartridge.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventCartridge.java Sun Sep 17 11:27:13 2006
@@ -247,6 +247,8 @@
* Initialize the handlers. For global handlers this is called when Velocity
* is initialized. For local handlers this is called when the first handler
* is executed. Handlers will not be initialized more than once.
+ * @param rs
+ * @throws Exception
*/
public void initialize (RuntimeServices rs) throws Exception
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/ReferenceInsertionEventHandler.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/ReferenceInsertionEventHandler.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/ReferenceInsertionEventHandler.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/ReferenceInsertionEventHandler.java Sun Sep 17 11:27:13 2006
@@ -36,7 +36,6 @@
* ReferenceInsertionEventHandlers are are registered then reference value
* is inserted into the output stream as is.
*
- * @param context the current velocity context
* @param reference Reference from template about to be inserted.
* @param value Value about to be inserted (after its <code>toString()</code>
* method is called).
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/RuntimeServicesAware.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/RuntimeServicesAware.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/RuntimeServicesAware.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/RuntimeServicesAware.java Sun Sep 17 11:27:13 2006
@@ -30,6 +30,8 @@
{
/**
* Initialize the EventHandler.
+ * @param rs
+ * @throws Exception
*/
public void setRuntimeServices( RuntimeServices rs ) throws Exception;
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeHtmlReference.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeHtmlReference.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeHtmlReference.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeHtmlReference.java Sun Sep 17 11:27:13 2006
@@ -4,7 +4,7 @@
/**
* Escape all HTML entities.
- * @see http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeHtml(java.lang.String)
+ * @see <a href="http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeHtml(java.lang.String)">StringEscapeUtils</a>
* @author wglass
*/
public class EscapeHtmlReference extends EscapeReference
@@ -12,7 +12,9 @@
/**
* Escape all HTML entities.
- * @see http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeHtml(java.lang.String)
+ * @param text
+ * @return An escaped String.
+ * @see <a href="http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeHtml(java.lang.String)">StringEscapeUtils</a>
*/
protected String escape(Object text)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeJavaScriptReference.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeJavaScriptReference.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeJavaScriptReference.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeJavaScriptReference.java Sun Sep 17 11:27:13 2006
@@ -4,7 +4,7 @@
/**
* Escapes the characters in a String to be suitable for use in JavaScript.
- * @see http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeJavaScript(java.lang.String)
+ * @see <a href="http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeJavaScript(java.lang.String)">StringEscapeUtils</a>
* @author wglass
*/
public class EscapeJavaScriptReference extends EscapeReference
@@ -12,7 +12,9 @@
/**
* Escapes the characters in a String to be suitable for use in JavaScript.
- * @see http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeXml(java.lang.String)
+ * @param text
+ * @return An escaped String.
+ * @see <a href="http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeJavaScript(java.lang.String)">StringEscapeUtils</a>
*/
protected String escape(Object text)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeReference.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeReference.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeReference.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeReference.java Sun Sep 17 11:27:13 2006
@@ -81,6 +81,9 @@
/**
* Escape the provided text if it matches the configured regular expression.
+ * @param reference
+ * @param value
+ * @return Escaped text.
*/
public Object referenceInsert(String reference, Object value)
{
@@ -107,6 +110,8 @@
/**
* Called automatically when event cartridge is initialized.
+ * @param rs
+ * @throws Exception
*/
public void setRuntimeServices(RuntimeServices rs) throws Exception
{
@@ -143,7 +148,7 @@
/**
* Retrieve a reference to RuntimeServices. Use this for checking additional
* configuration properties.
- * @return
+ * @return The current runtime services object.
*/
protected RuntimeServices getRuntimeServices()
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeSqlReference.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeSqlReference.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeSqlReference.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeSqlReference.java Sun Sep 17 11:27:13 2006
@@ -4,7 +4,7 @@
/**
* Escapes the characters in a String to be suitable to pass to an SQL query.
- * @see http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeSql(java.lang.String)
+ * @see <a href="http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeSql(java.lang.String)">StringEscapeUtils</a>
* @author wglass
*/
public class EscapeSqlReference extends EscapeReference
@@ -12,7 +12,9 @@
/**
* Escapes the characters in a String to be suitable to pass to an SQL query.
- * @see http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeXml(java.lang.String)
+ * @param text
+ * @return An escaped string.
+ * @see <a href="http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeSql(java.lang.String)">StringEscapeUtils</a>
*/
protected String escape(Object text)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeXmlReference.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeXmlReference.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeXmlReference.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/EscapeXmlReference.java Sun Sep 17 11:27:13 2006
@@ -4,7 +4,7 @@
/**
* Escape all XML entities.
- * @see http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeHtml(java.lang.String)
+ * @see <a href="http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeSql(java.lang.String)">StringEscapeUtils</a>
* @author wglass
*/
public class EscapeXmlReference extends EscapeReference
@@ -12,7 +12,9 @@
/**
* Escape all XML entities.
- * @see http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeXml(java.lang.String)
+ * @param text
+ * @return An escaped String.
+ * @see <a href="http://jakarta.apache.org/commons/lang/api/org/apache/commons/lang/StringEscapeUtils.html#escapeSql(java.lang.String)">StringEscapeUtils</a>
*/
protected String escape(Object text)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/IncludeNotFound.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/IncludeNotFound.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/IncludeNotFound.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/IncludeNotFound.java Sun Sep 17 11:27:13 2006
@@ -49,6 +49,10 @@
* Chseck to see if included file exists, and display "not found" page if it
* doesn't. If "not found" page does not exist, log an error and return
* null.
+ * @param includeResourcePath
+ * @param currentResourcePath
+ * @param directiveName
+ * @return message.
*/
public String includeEvent(
String includeResourcePath,
@@ -82,6 +86,9 @@
}
+ /**
+ * @see org.apache.velocity.app.event.RuntimeServicesAware#setRuntimeServices(org.apache.velocity.runtime.RuntimeServices)
+ */
public void setRuntimeServices(RuntimeServices rs) throws Exception
{
this.rs = rs;
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/IncludeRelativePath.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/IncludeRelativePath.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/IncludeRelativePath.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/IncludeRelativePath.java Sun Sep 17 11:27:13 2006
@@ -31,6 +31,10 @@
/**
* Return path relative to the current template's path.
+ * @param includeResourcePath
+ * @param currentResourcePath
+ * @param directiveName
+ * @return Include String.
*/
public String includeEvent(
String includeResourcePath,
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/PrintExceptions.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/PrintExceptions.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/PrintExceptions.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/PrintExceptions.java Sun Sep 17 11:27:13 2006
@@ -46,6 +46,11 @@
/**
* Render the method exception, and optionally the exception message and stack trace.
+ * @param claz
+ * @param method
+ * @param e
+ * @return Exception Message.
+ * @throws Exception
*/
public Object methodException(Class claz, String method, Exception e) throws Exception
{
@@ -104,6 +109,9 @@
}
+ /**
+ * @see org.apache.velocity.app.event.RuntimeServicesAware#setRuntimeServices(org.apache.velocity.runtime.RuntimeServices)
+ */
public void setRuntimeServices(RuntimeServices rs) throws Exception
{
this.rs = rs;
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/tools/VelocityFormatter.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/tools/VelocityFormatter.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/tools/VelocityFormatter.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/tools/VelocityFormatter.java Sun Sep 17 11:27:13 2006
@@ -137,7 +137,7 @@
*
* @param array An Object.
* @param delim A String.
- * @param finalDelim A String.
+ * @param finaldelim A String.
* @return A String.
*/
public String formatArray(Object array,
@@ -194,7 +194,7 @@
*
* @param list The list of elements to format.
* @param delim A String.
- * @param finalDelim A String.
+ * @param finaldelim A String.
* @return A String.
*/
public String formatVector(List list,
@@ -263,7 +263,13 @@
*/
public class VelocityAlternator
{
+ /**
+ *
+ */
protected String[] alternates = null;
+ /**
+ *
+ */
protected int current = 0;
/**
@@ -363,6 +369,11 @@
/**
* Makes an alternator object that alternates between three
* values.
+ * @param name
+ * @param alt1
+ * @param alt2
+ * @param alt3
+ * @return alternated object.
*
* @see #makeAlternator(String name, String alt1, String alt2)
*/
@@ -378,6 +389,12 @@
/**
* Makes an alternator object that alternates between four values.
+ * @param name
+ * @param alt1
+ * @param alt2
+ * @param alt3
+ * @param alt4
+ * @return Alternated object.
*
* @see #makeAlternator(String name, String alt1, String alt2)
*/
@@ -392,6 +409,10 @@
/**
* Makes an alternator object that alternates between two values
* automatically.
+ * @param name
+ * @param alt1
+ * @param alt2
+ * @return Alternated object.
*
* @see #makeAlternator(String name, String alt1, String alt2)
*/
@@ -404,6 +425,9 @@
/**
* Returns a default value if the object passed is null.
+ * @param o
+ * @param dflt
+ * @return Object or default value when object is null.
*/
public Object isNull(Object o, Object dflt)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/ParserPool.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/ParserPool.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/ParserPool.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/ParserPool.java Sun Sep 17 11:27:13 2006
@@ -30,16 +30,19 @@
{
/**
* Initialize the pool so that it can begin serving parser instances.
+ * @param svc
*/
void initialize(RuntimeServices svc);
/**
* Retrieve an instance of a parser pool.
+ * @return A parser object.
*/
Parser get();
/**
* Return the parser to the pool so that it may be reused.
+ * @param parser
*/
void put(Parser parser);
}
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/ParserPoolImpl.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/ParserPoolImpl.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/ParserPoolImpl.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/ParserPoolImpl.java Sun Sep 17 11:27:13 2006
@@ -34,6 +34,7 @@
/**
* Create the underlying "pool".
+ * @param rsvc
*/
public void initialize(RuntimeServices rsvc)
{
@@ -55,6 +56,7 @@
/**
* Call the wrapped pool. If none are available, it will create a new
* temporary one.
+ * @return A parser Object.
*/
public Parser get()
{
@@ -71,6 +73,7 @@
/**
* Call the wrapped pool.
+ * @param parser
*/
public void put(Parser parser)
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeConstants.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeConstants.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeConstants.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeConstants.java Sun Sep 17 11:27:13 2006
@@ -159,6 +159,9 @@
* ----------------------------------------------------------------------
*/
+ /**
+ *
+ */
public static String RESOURCE_MANAGER_CLASS = "resource.manager.class";
/**
@@ -328,6 +331,9 @@
*/
public static final String OUTPUT_ENCODING = "output.encoding";
+ /**
+ * Default Encoding is ISO-8859-1.
+ */
public static final String ENCODING_DEFAULT = "ISO-8859-1";
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeLogger.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeLogger.java?view=diff&rev=447106&r1=447105&r2=447106
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeLogger.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/runtime/RuntimeLogger.java Sun Sep 17 11:27:13 2006
@@ -1,5 +1,7 @@
package org.apache.velocity.runtime;
+import org.apache.velocity.runtime.log.Log;
+
/*
* Copyright 2002-2004 The Apache Software Foundation.
*
@@ -27,22 +29,30 @@
public interface RuntimeLogger
{
/**
- * @deprecated Use Log.warn(Object)
+ * @deprecated Use Log.warn(Object).
+ * @see Log#warn(Object)
+ * @param message The message to log.
*/
public void warn(Object message);
/**
- * @deprecated Use Log.warn(Object)
+ * @deprecated Use Log.info(Object)
+ * @see Log#info(Object)
+ * @param message The message to log.
*/
public void info(Object message);
/**
- * @deprecated Use Log.warn(Object)
+ * @deprecated Use Log.error(Object)
+ * @see Log#error(Object)
+ * @param message The message to log.
*/
public void error(Object message);
/**
- * @deprecated Use Log.warn(Object)
+ * @deprecated Use Log.debug(Object)
+ * @see Log#debug(Object)
+ * @param message The message to log.
*/
public void debug(Object message);
}
---------------------------------------------------------------------
To unsubscribe, e-mail: velocity-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: velocity-dev-help@jakarta.apache.org