You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by wg...@apache.org on 2006/11/02 08:20:37 UTC
svn commit: r470256 - in
/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event: ./
implement/
Author: wglass
Date: Wed Nov 1 23:20:36 2006
New Revision: 470256
URL: http://svn.apache.org/viewvc?view=rev&rev=470256
Log:
VELOCITY-423. Cleaned up Javadocs.
Modified:
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventCartridge.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventHandlerMethodExecutor.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventHandlerUtil.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/InvalidReferenceEventHandler.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/MethodExceptionEventHandler.java
jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/NullSetEventHandler.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/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/InvalidReferenceInfo.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/event/implement/ReportInvalidReferences.java
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=470256&r1=470255&r2=470256
==============================================================================
--- 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 Wed Nov 1 23:20:36 2006
@@ -203,6 +203,7 @@
/**
* Iterate through all the stored ReferenceInsertionEventHandler objects
+ *
* @return iterator of handler objects
*/
public Iterator getReferenceInsertionEventHandlers()
@@ -212,6 +213,7 @@
/**
* Iterate through all the stored NullSetEventHandler objects
+ *
* @return iterator of handler objects
*/
public Iterator getNullSetEventHandlers()
@@ -221,6 +223,7 @@
/**
* Iterate through all the stored MethodExceptionEventHandler objects
+ *
* @return iterator of handler objects
*/
public Iterator getMethodExceptionEventHandlers()
@@ -230,6 +233,7 @@
/**
* Iterate through all the stored IncludeEventHandlers objects
+ *
* @return iterator of handler objects
*/
public Iterator getIncludeEventHandlers()
@@ -239,6 +243,7 @@
/**
* Iterate through all the stored InvalidReferenceEventHandlers objects
+ *
* @return iterator of handler objects
*/
public Iterator getInvalidReferenceEventHandlers()
@@ -281,6 +286,7 @@
* 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
*/
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventHandlerMethodExecutor.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventHandlerMethodExecutor.java?view=diff&rev=470256&r1=470255&r2=470256
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventHandlerMethodExecutor.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventHandlerMethodExecutor.java Wed Nov 1 23:20:36 2006
@@ -36,18 +36,21 @@
* If appropriate, the returned Object will be the return value.
*
* @param handler call the appropriate method on this handler
+ * @exception Exception generic exception potentially thrown by event handlers
*/
public void execute(EventHandler handler) throws Exception;
/**
* Called after execute() to see if iterating should stop. Should
* always return false before method execute() is run.
- * @return
+ *
+ * @return true if no more event handlers for this method should be called.
*/
public boolean isDone();
/**
* Get return value at end of all the iterations
+ *
* @return null if no return value is required
*/
public Object getReturnValue();
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventHandlerUtil.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventHandlerUtil.java?view=diff&rev=470256&r1=470255&r2=470256
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventHandlerUtil.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/EventHandlerUtil.java Wed Nov 1 23:20:36 2006
@@ -46,7 +46,7 @@
*
* @param reference reference from template about to be inserted
* @param value value about to be inserted (after toString() )
- * @param rsvc The RuntimeServices Object.
+ * @param rsvc current instance of RuntimeServices
* @param context The internal context adapter.
* @return Object on which toString() should be called for output.
*/
@@ -91,7 +91,7 @@
*
* @param lhs Left hand side of the expression.
* @param rhs Right hand side of the expression.
- * @param rsvc The RuntimeServices Object.
+ * @param rsvc current instance of RuntimeServices
* @param context The internal context adapter.
* @return true if to be logged, false otherwise
*/
@@ -140,7 +140,7 @@
* method called that causes the exception
* @param e
* Exception thrown by the method
- * @param rsvc The RuntimeServices Object.
+ * @param rsvc current instance of RuntimeServices
* @param context The internal context adapter.
* @return Object to return as method result
* @throws Exception
@@ -190,7 +190,7 @@
* @param directiveName
* name of the directive used to include the resource. (With the
* standard directives this is either "parse" or "include").
- * @param rsvc The RuntimeServices Object.
+ * @param rsvc current instance of RuntimeServices
* @param context The internal context adapter.
*
* @return a new resource path for the directive, or null to block the
@@ -237,13 +237,13 @@
/**
* Called when an invalid get method is encountered.
*
- * @param rsvc The RuntimeServices Object.
+ * @param rsvc current instance of RuntimeServices
* @param context the context when the reference was found invalid
* @param reference complete invalid reference
* @param object object from reference, or null if not available
* @param property name of property, or null if not relevant
* @param info contains info on template, line, col
- * @return
+ * @return substitute return value for missing reference, or null if no substitute
*/
public static Object invalidGetMethod(RuntimeServices rsvc,
InternalContextAdapter context, String reference,
@@ -259,13 +259,12 @@
/**
- * Called when an invalid get method is encountered.
+ * Called when an invalid set method is encountered.
*
- * @param rsvc The RuntimeServices Object.
+ * @param rsvc current instance of RuntimeServices
* @param context the context when the reference was found invalid
- * @param reference complete invalid reference
- * @param object object from reference, or null if not available
- * @param property name of property, or null if not relevant
+ * @param leftreference left reference being assigned to
+ * @param rightreference invalid reference on the right
* @param info contains info on template, line, col
*/
public static void invalidSetMethod(RuntimeServices rsvc,
@@ -285,13 +284,13 @@
/**
* Called when an invalid method is encountered.
*
- * @param rsvc The RuntimeServices Object.
+ * @param rsvc current instance of RuntimeServices
* @param context the context when the reference was found invalid
* @param reference complete invalid reference
* @param object object from reference, or null if not available
* @param method name of method, or null if not relevant
* @param info contains info on template, line, col
- * @return
+ * @return substitute return value for missing reference, or null if no substitute
*/
public static Object invalidMethod(RuntimeServices rsvc,
InternalContextAdapter context, String reference,
@@ -307,11 +306,12 @@
/**
- * Generic call to InvalidReferenceEventHandler method.
+ * Calls event handler method with appropriate chaining across event handlers.
+ *
* @param methodExecutor
- * @param rsvc
- * @param context
- * @return
+ * @param rsvc current instance of RuntimeServices
+ * @param context The current context
+ * @return return value from method, or null if no return value
*/
public static Object invalidReferenceHandlerCall(
EventHandlerMethodExecutor methodExecutor,
@@ -349,8 +349,9 @@
/**
* Initialize the event cartridge if appropriate.
- * @param rsvc
- * @param eventCartridge
+ *
+ * @param rsvc current instance of RuntimeServices
+ * @param eventCartridge the event cartridge to be initialized
*/
private static void initializeEventCartridge(RuntimeServices rsvc, EventCartridge eventCartridge)
{
@@ -369,11 +370,12 @@
/**
- * Loop through both the application level and context-attached event handlers
- * @param rsvc
- * @param applicationEventHandlerIterator
- * @param contextEventHandlerIterator
- * @param eventExecutor
+ * Loop through both the application level and context-attached event handlers.
+ *
+ * @param applicationEventHandlerIterator Iterator that loops through all global event handlers declared at application level
+ * @param contextEventHandlerIterator Iterator that loops through all global event handlers attached to context
+ * @param eventExecutor Strategy object that executes event handler method
+ * @exception Exception generic exception potentially thrown by event handlers
*/
private static void callEventHandlers(
Iterator applicationEventHandlerIterator,
@@ -395,9 +397,10 @@
/**
* Loop through a given iterator of event handlers.
- * @param returnValue
- * @param handlerIterator
- * @param eventExecutor
+ *
+ * @param handlerIterator Iterator that loops through event handlers
+ * @param eventExecutor Strategy object that executes event handler method
+ * @exception Exception generic exception potentially thrown by event handlers
*/
private static void iterateOverEventHandlers(
Iterator handlerIterator,
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/InvalidReferenceEventHandler.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/InvalidReferenceEventHandler.java?view=diff&rev=470256&r1=470255&r2=470256
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/InvalidReferenceEventHandler.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/InvalidReferenceEventHandler.java Wed Nov 1 23:20:36 2006
@@ -24,7 +24,7 @@
/**
* Event handler called when an invalid reference is encountered. Allows
- * the application to report errors or substitute return values. <May be chained
+ * the application to report errors or substitute return values. May be chained
* in sequence; the behavior will differ per method.
*
* <p>This feature should be regarded as experimental.
@@ -47,7 +47,7 @@
* @param object the object referred to, or null if not found
* @param property the property name from the reference
* @param info contains template, line, column details
- * @return substitute return value for missing reference
+ * @return substitute return value for missing reference, or null if no substitute
*/
public Object invalidGetMethod(Context context, String reference,
Object object, String property, Info info);
@@ -60,11 +60,11 @@
* for easy chaining.
*
* @param context the context when the reference was found invalid
- * @param leftreference string to which the value is being assigned
- * @param rightreference the invalid reference on the right
- * @param property the property name from the reference
- * @param info contains template, line, column details
- * @param if true then stop calling invalidSetMethod along the
+ * @param leftreference left reference being assigned to
+ * @param rightreference invalid reference on the right
+ * @param info contains info on template, line, col
+ *
+ * @return if true then stop calling invalidSetMethod along the
* chain.
*/
public boolean invalidSetMethod(Context context, String leftreference,
@@ -80,7 +80,7 @@
* @param object the object referred to, or null if not found
* @param method the name of the (non-existent) method
* @param info contains template, line, column details
- * @return substitute return value for missing reference
+ * @return substitute return value for missing reference, or null if no substitute
*/
public Object invalidMethod(Context context, String reference,
Object object, String method, Info info);
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/MethodExceptionEventHandler.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/MethodExceptionEventHandler.java?view=diff&rev=470256&r1=470255&r2=470256
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/MethodExceptionEventHandler.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/MethodExceptionEventHandler.java Wed Nov 1 23:20:36 2006
@@ -78,7 +78,7 @@
* Call the method methodException()
*
* @param handler call the appropriate method on this handler
- * @return null to continue iterating, any non-null object to stop.
+ * @exception Exception generic exception thrown by methodException event handler method call
*/
public void execute(EventHandler handler) throws Exception
{
@@ -98,6 +98,8 @@
/**
* Only run the first MethodExceptionEventHandler
+ *
+ * @return true after this is executed once.
*/
public boolean isDone()
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/NullSetEventHandler.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/NullSetEventHandler.java?view=diff&rev=470256&r1=470255&r2=470256
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/NullSetEventHandler.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/NullSetEventHandler.java Wed Nov 1 23:20:36 2006
@@ -69,6 +69,11 @@
this.rhs = rhs;
}
+ /**
+ * Call the method shouldLogOnNullSet()
+ *
+ * @param handler call the appropriate method on this handler
+ */
public void execute(EventHandler handler)
{
NullSetEventHandler eh = (NullSetEventHandler) handler;
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=470256&r1=470255&r2=470256
==============================================================================
--- 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 Wed Nov 1 23:20:36 2006
@@ -93,6 +93,8 @@
/**
* Continue to end of event handler iteration
+ *
+ * @return always returns false
*/
public boolean isDone()
{
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=470256&r1=470255&r2=470256
==============================================================================
--- 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 Wed Nov 1 23:20:36 2006
@@ -31,6 +31,7 @@
/**
* Escape all HTML entities.
+ *
* @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>
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=470256&r1=470255&r2=470256
==============================================================================
--- 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 Wed Nov 1 23:20:36 2006
@@ -31,6 +31,7 @@
/**
* Escapes the characters in a String to be suitable for use in JavaScript.
+ *
* @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>
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=470256&r1=470255&r2=470256
==============================================================================
--- 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 Wed Nov 1 23:20:36 2006
@@ -84,6 +84,7 @@
/**
* Escape the provided text if it matches the configured regular expression.
+ *
* @param reference
* @param value
* @return Escaped text.
@@ -113,8 +114,8 @@
/**
* Called automatically when event cartridge is initialized.
- * @param rs
- * @throws Exception
+ *
+ * @param rs instance of RuntimeServices
*/
public void setRuntimeServices(RuntimeServices rs)
{
@@ -151,6 +152,7 @@
/**
* Retrieve a reference to RuntimeServices. Use this for checking additional
* configuration properties.
+ *
* @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=470256&r1=470255&r2=470256
==============================================================================
--- 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 Wed Nov 1 23:20:36 2006
@@ -31,6 +31,7 @@
/**
* Escapes the characters in a String to be suitable to pass to an SQL query.
+ *
* @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>
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=470256&r1=470255&r2=470256
==============================================================================
--- 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 Wed Nov 1 23:20:36 2006
@@ -31,6 +31,7 @@
/**
* Escape all XML entities.
+ *
* @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>
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=470256&r1=470255&r2=470256
==============================================================================
--- 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 Wed Nov 1 23:20:36 2006
@@ -52,6 +52,7 @@
* 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
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=470256&r1=470255&r2=470256
==============================================================================
--- 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 Wed Nov 1 23:20:36 2006
@@ -34,10 +34,14 @@
/**
* Return path relative to the current template's path.
- * @param includeResourcePath
- * @param currentResourcePath
- * @param directiveName
- * @return Include String.
+ *
+ * @param includeResourcePath the path as given in the include directive.
+ * @param currentResourcePath the path of the currently rendering template that includes the
+ * include directive.
+ * @param directiveName name of the directive used to include the resource. (With the
+ * standard directives this is either "parse" or "include").
+
+ * @return new path relative to the current template's path
*/
public String includeEvent(
String includeResourcePath,
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/InvalidReferenceInfo.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/InvalidReferenceInfo.java?view=diff&rev=470256&r1=470255&r2=470256
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/InvalidReferenceInfo.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/InvalidReferenceInfo.java Wed Nov 1 23:20:36 2006
@@ -51,7 +51,7 @@
/**
* Formats a textual representation of this object as <code>SOURCE
- * [line X, column Y]</code>.
+ * [line X, column Y]: invalidReference</code>.
*
* @return String representing this object.
*/
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=470256&r1=470255&r2=470256
==============================================================================
--- 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 Wed Nov 1 23:20:36 2006
@@ -49,11 +49,12 @@
/**
* Render the method exception, and optionally the exception message and stack trace.
- * @param claz
- * @param method
- * @param e
- * @return Exception Message.
- * @throws Exception
+ *
+ * @param claz the class of the object the method is being applied to
+ * @param method the method
+ * @param e the thrown exception
+ * @return an object to insert in the page
+ * @throws Exception an exception to be thrown instead inserting an object
*/
public Object methodException(Class claz, String method, Exception e) throws Exception
{
Modified: jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/ReportInvalidReferences.java
URL: http://svn.apache.org/viewvc/jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/ReportInvalidReferences.java?view=diff&rev=470256&r1=470255&r2=470256
==============================================================================
--- jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/ReportInvalidReferences.java (original)
+++ jakarta/velocity/engine/trunk/src/java/org/apache/velocity/app/event/implement/ReportInvalidReferences.java Wed Nov 1 23:20:36 2006
@@ -121,12 +121,10 @@
* Collect the error and/or throw an exception, depending on configuration.
*
* @param context the context when the reference was found invalid
- * @param reference string with complete invalid reference
- * @param object the object referred to, or null if not found
- * @param method the name of the (non-existent) method
- * @param info contains template, line, column details
- * @param always returns false
- * @throws ParseErrorException
+ * @param leftreference left reference being assigned to
+ * @param rightreference invalid reference on the right
+ * @param info contains info on template, line, col
+ * @return loop to end -- always returns false
*/
public boolean invalidSetMethod(Context context, String leftreference, String rightreference, Info info)
{
@@ -139,7 +137,8 @@
* Check for an invalid reference and collect the error or throw an exception
* (depending on configuration).
*
- * @throws ParseErrorException
+ * @param reference the invalid reference
+ * @param info line, column, template name
*/
private void reportInvalidReference(String reference, Info info)
{
---------------------------------------------------------------------
To unsubscribe, e-mail: velocity-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: velocity-dev-help@jakarta.apache.org
Re: svn commit: r470256 - in
Posted by "Henning P. Schmiedehausen" <hp...@intermeta.de>.
wglass@apache.org writes:
> * Iterate through all the stored ReferenceInsertionEventHandler objects
>+ *
Hi,
cool, thanks! I don't think that the extra empty line is needed, but
if you _want_ to clean up that stuff, then it would be great to add a
"." to the end of the sentences, because the Javadoc parser actually
uses that to determine the end of the first sentence which then in
turn is used as "short description" of a method.
Best regards
Henning
--
Dipl.-Inf. (Univ.) Henning P. Schmiedehausen INTERMETA GmbH
hps@intermeta.de +49 9131 50 654 0 http://www.intermeta.de/
RedHat Certified Engineer -- Jakarta Turbine Development -- hero for hire
Linux, Java, perl, Solaris -- Consulting, Training, Development
Social behaviour: Bavarians can be extremely egalitarian and folksy.
-- http://en.wikipedia.org/wiki/Bavaria
Most Franconians do not like to be called Bavarians.
-- http://en.wikipedia.org/wiki/Franconia
---------------------------------------------------------------------
To unsubscribe, e-mail: velocity-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: velocity-dev-help@jakarta.apache.org