Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/StringResourceLoader.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/StringResourceLoader.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/StringResourceLoader.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/StringResourceLoader.java Mon Mar 11 11:09:53 2019 @@ -75,17 +75,17 @@ import java.util.Map; * <pre><code> * StringResourceRepository repo = StringResourceLoader.getRepository("foo"); * </code></pre> - * and add string resources to the repo just as in the previous example. + * <p>and add string resources to the repo just as in the previous example. * </p> * <p>If you have concerns about memory leaks or for whatever reason do not wish * to have your string repository stored statically as a class member, then you * should set 'resource.loader.string.repository.static = false' in your properties. * This will tell the resource loader that the string repository should be stored - * in the Velocity application attributes. To retrieve the repository, do: + * in the Velocity application attributes. To retrieve the repository, do:</p> * <pre><code> * StringResourceRepository repo = velocityEngine.getApplicationAttribute("foo"); * </code></pre> - * If you did not specify a name for the repository, then it will be stored under the + * <p>If you did not specify a name for the repository, then it will be stored under the * class name of the repository implementation class (for which the default is * 'org.apache.velocity.runtime.resource.util.StringResourceRepositoryImpl'). * Incidentally, this is also true for the default statically stored repository. @@ -98,13 +98,13 @@ import java.util.Map; * repo.magicallyAddSomeStringResources(); * StringResourceLoader.setRepository("foo", repo); * </code></pre> - * Or for a non-static repository: + * <p>Or for a non-static repository:</p> * <pre><code> * StringResourceRepository repo = new MyStringResourceRepository(); * repo.magicallyAddSomeStringResources(); * velocityEngine.setApplicationAttribute("foo", repo); * </code></pre> - * Then, assuming the 'resource.loader.string.repository.name' property is + * <p>Then, assuming the 'resource.loader.string.repository.name' property is * set to 'some.name', the StringResourceLoader will use that already created * repository, rather than creating a new one. * </p> @@ -157,6 +157,7 @@ public class StringResourceLoader extend /** * Returns a reference to the default static repository. + * @return default static repository */ public static StringResourceRepository getRepository() { @@ -166,6 +167,8 @@ public class StringResourceLoader extend /** * Returns a reference to the repository stored statically under the * specified name. + * @param name + * @return named repository * @since 1.6 */ public static StringResourceRepository getRepository(String name) @@ -176,6 +179,8 @@ public class StringResourceLoader extend /** * Sets the specified {@link StringResourceRepository} in static storage * under the specified name. + * @param name + * @param repo * @since 1.6 */ public static void setRepository(String name, StringResourceRepository repo) @@ -186,6 +191,8 @@ public class StringResourceLoader extend /** * Removes the {@link StringResourceRepository} stored under the specified * name. + * @param name + * @return removed repository * @since 1.6 */ public static StringResourceRepository removeRepository(String name) @@ -203,11 +210,14 @@ public class StringResourceLoader extend } - // the repository used internally by this resource loader + /** + * the repository used internally by this resource loader + */ protected StringResourceRepository repository; /** + * @param configuration * @see ResourceLoader#init(org.apache.velocity.util.ExtProperties) */ public void init(final ExtProperties configuration) @@ -278,6 +288,9 @@ public class StringResourceLoader extend } /** + * @param className + * @param encoding + * @return created repository * @since 1.6 */ public StringResourceRepository createRepository(final String className, @@ -318,6 +331,8 @@ public class StringResourceLoader extend /** * Overrides superclass for better performance. + * @param name resource name + * @return whether resource exists * @since 1.6 */ public boolean resourceExists(final String name) @@ -379,6 +394,8 @@ public class StringResourceLoader extend } /** + * @param resource + * @return whether resource was modified * @see ResourceLoader#isSourceModified(org.apache.velocity.runtime.resource.Resource) */ public boolean isSourceModified(final Resource resource) @@ -397,6 +414,8 @@ public class StringResourceLoader extend } /** + * @param resource + * @return last modified timestamp * @see ResourceLoader#getLastModified(org.apache.velocity.runtime.resource.Resource) */ public long getLastModified(final Resource resource)
Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/URLResourceLoader.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/URLResourceLoader.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/URLResourceLoader.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/loader/URLResourceLoader.java Mon Mar 11 11:09:53 2019 @@ -48,6 +48,7 @@ public class URLResourceLoader extends R private int timeout = -1; /** + * @param configuration * @see ResourceLoader#init(org.apache.velocity.util.ExtProperties) */ public void init(ExtProperties configuration) @@ -200,6 +201,7 @@ public class URLResourceLoader extends R /** * Returns the current, custom timeout setting. If negative, there is no custom timeout. + * @return timeout * @since 1.6 */ public int getTimeout() Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/util/StringResource.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/util/StringResource.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/util/StringResource.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/runtime/resource/util/StringResource.java Mon Mar 11 11:09:53 2019 @@ -42,6 +42,7 @@ public final class StringResource /** * convenience constructor; sets body to 'body' and sets lastModified to now * @param body + * @param encoding */ public StringResource(final String body, final String encoding) { Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/DeprecationAwareExtProperties.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/DeprecationAwareExtProperties.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/DeprecationAwareExtProperties.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/DeprecationAwareExtProperties.java Mon Mar 11 11:09:53 2019 @@ -49,6 +49,8 @@ public class DeprecationAwareExtProperti /** * Emit a warning in the log for adeprecated property name + * @param oldName old property name + * @param newName new property name */ protected void warnDeprecated(String oldName, String newName) { Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/DuckType.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/DuckType.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/DuckType.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/DuckType.java Mon Mar 11 11:09:53 2019 @@ -30,7 +30,7 @@ import java.util.Map; import static org.apache.velocity.runtime.parser.node.MathUtils.isZero; /** - * Support for getAs<Type>() convention for rendering (String), evaluating (Boolean) + * Support for getAs<java.lang.reflect.Type>() convention for rendering (String), evaluating (Boolean) * or doing math with (Number) references. * * @author Nathan Bubna Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/ExtProperties.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/ExtProperties.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/ExtProperties.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/ExtProperties.java Mon Mar 11 11:09:53 2019 @@ -97,9 +97,9 @@ import java.util.Vector; * </li> * </ul> * - * <p>Here is an example of a valid extended properties file: + * <p>Here is an example of a valid extended properties file:</p> * - * <p><pre> + * <pre><code> * # lines starting with # are comments * * # This is the simplest property @@ -118,7 +118,7 @@ import java.util.Vector; * * # commas may be escaped in tokens * commas.escaped = Hi\, what'up? - * </pre> + * </code></pre> * * <p><b>NOTE</b>: this class has <b>not</b> been written for * performance nor low memory usage. In fact, it's way slower than it @@ -566,6 +566,7 @@ public class ExtProperties extends Depre /** * Indicate to client code whether property * resources have been initialized or not. + * @return initialization status */ public boolean isInitialized() { @@ -1134,6 +1135,7 @@ public class ExtProperties extends Depre * configuration key. * * @param key The configuration key. + * @param defaults default values * @return The associated properties if key is found. * @throws ClassCastException is thrown if the key maps to an * object that is not a String/List. Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/StringUtils.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/StringUtils.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/StringUtils.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/StringUtils.java Mon Mar 11 11:09:53 2019 @@ -38,6 +38,8 @@ public class StringUtils * Creates a string that formats the template filename with line number * and column of the given Directive. We use this routine to provide a consistent format for displaying * file errors. + * @param directive currrent directive + * @return formatted string */ public static String formatFileString(Directive directive) { @@ -48,6 +50,8 @@ public class StringUtils * Creates a string that formats the template filename with line number * and column of the given Node. We use this routine to provide a consistent format for displaying * file errors. + * @param node current node + * @return formatted string */ public static String formatFileString(Node node) { @@ -58,6 +62,8 @@ public class StringUtils * Simply creates a string that formats the template filename with line number * and column. We use this routine to provide a consistent format for displaying * file errors. + * @param info template name, line and column infos + * @return formatted string */ public static String formatFileString(Info info) { @@ -71,6 +77,7 @@ public class StringUtils * @param template File name of template, can be null * @param linenum Line number within the file * @param colnum Column number withing the file at linenum + * @return formatted string */ public static String formatFileString(String template, int linenum, int colnum) { Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/ClassFieldMap.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/ClassFieldMap.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/ClassFieldMap.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/ClassFieldMap.java Mon Mar 11 11:09:53 2019 @@ -61,6 +61,7 @@ public class ClassFieldMap /** * Standard constructor * @param clazz The class for which this ClassMap gets constructed. + * @param log logger */ public ClassFieldMap(final Class clazz, final Logger log) { Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/ClassMap.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/ClassMap.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/ClassMap.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/ClassMap.java Mon Mar 11 11:09:53 2019 @@ -60,6 +60,7 @@ public class ClassMap /** * Standard constructor * @param clazz The class for which this ClassMap gets constructed. + * @param log logger */ public ClassMap(final Class clazz, final Logger log) { Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/ConversionHandler.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/ConversionHandler.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/ConversionHandler.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/ConversionHandler.java Mon Mar 11 11:09:53 2019 @@ -40,6 +40,7 @@ public interface ConversionHandler * * @param formal expected formal type * @param actual provided argument type + * @param possibleVarArg whether var arg is possible here * @return null if no conversion is needed, or the appropriate Converter object * @since 2.0 */ Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/IntrospectorBase.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/IntrospectorBase.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/IntrospectorBase.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/IntrospectorBase.java Mon Mar 11 11:09:53 2019 @@ -64,6 +64,8 @@ public abstract class IntrospectorBase /** * C'tor. + * @param log logger + * @param conversionHandler conversion handler */ protected IntrospectorBase(final Logger log, final TypeConversionHandler conversionHandler) { Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/IntrospectorCache.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/IntrospectorCache.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/IntrospectorCache.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/IntrospectorCache.java Mon Mar 11 11:09:53 2019 @@ -72,6 +72,8 @@ public final class IntrospectorCache /** * C'tor + * @param log logger. + * @param conversionHandler conversion handler */ public IntrospectorCache(final Logger log, final TypeConversionHandler conversionHandler) { Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/LinkingUberspector.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/LinkingUberspector.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/LinkingUberspector.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/LinkingUberspector.java Mon Mar 11 11:09:53 2019 @@ -41,6 +41,8 @@ public class LinkingUberspector extends /** * Constructor that takes the two uberspectors to link + * @param left left uberspector + * @param right right uberspector */ public LinkingUberspector(Uberspect left,Uberspect right) { leftUberspect = left; Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/SecureIntrospectorControl.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/SecureIntrospectorControl.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/SecureIntrospectorControl.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/SecureIntrospectorControl.java Mon Mar 11 11:09:53 2019 @@ -22,7 +22,7 @@ package org.apache.velocity.util.introsp /** * Interface used to determine which methods are allowed to be executed. * - * @author <a href="Will Glass-Husain">[email protected]</a> + * @author <a href="mailto:[email protected]";>Will Glass-Husain</a> * @version $Id$ * @since 1.5 */ Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/TypeConversionHandler.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/TypeConversionHandler.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/TypeConversionHandler.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/TypeConversionHandler.java Mon Mar 11 11:09:53 2019 @@ -38,6 +38,7 @@ public interface TypeConversionHandler * Check to see if the conversion can be done using an explicit conversion * @param formal expected formal type * @param actual provided argument type + * @param possibleVarArg whether var arg is possible * @return null if no conversion is needed, or the appropriate Converter object * @since 2.1 */ Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/UberspectImpl.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/UberspectImpl.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/UberspectImpl.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/UberspectImpl.java Mon Mar 11 11:09:53 2019 @@ -471,6 +471,8 @@ public class UberspectImpl implements Ub } /** + * @param method + * @param wrapArray * @since 1.6 */ public VelMethodImpl(Method method, boolean wrapArray) @@ -479,6 +481,9 @@ public class UberspectImpl implements Ub } /** + * @param method + * @param wrapArray + * @param converters * @since 2.0 */ public VelMethodImpl(Method method, boolean wrapArray, Converter[] converters) @@ -494,6 +499,9 @@ public class UberspectImpl implements Ub } /** + * @param o + * @param actual + * @return invocation result * @see VelMethod#invoke(java.lang.Object, java.lang.Object[]) */ public Object invoke(Object o, Object[] actual) @@ -535,6 +543,11 @@ public class UberspectImpl implements Ub * Offers an extension point for subclasses (in alternate Uberspects) * to alter the invocation after any array wrapping or varargs handling * has already been completed. + * @param o target object + * @param actual arguments + * @return invocation result + * @throws IllegalAccessException + * @throws InvocationTargetException * @since 1.6 */ protected Object doInvoke(Object o, Object[] actual) Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/UberspectPublicFields.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/UberspectPublicFields.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/UberspectPublicFields.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/UberspectPublicFields.java Mon Mar 11 11:09:53 2019 @@ -64,7 +64,6 @@ public class UberspectPublicFields imple * @param identifier * @param i * @return A Velocity Getter Method. - * @throws Exception */ public VelPropertyGet getPropertyGet(Object obj, String identifier, Info i) { @@ -87,7 +86,6 @@ public class UberspectPublicFields imple * @param arg * @param i * @return A Velocity Setter method. - * @throws Exception */ public VelPropertySet getPropertySet(Object obj, String identifier, Object arg, Info i) { @@ -103,16 +101,31 @@ public class UberspectPublicFields imple return (executor.isAlive()) ? new VelSetterImpl(executor) : null; } + /** + * @param obj + * @param info + * @return iterator + */ public Iterator getIterator(Object obj, Info info) { return null; } + /** + * @param obj + * @param method + * @param args + * @param info + * @return method wrapper + */ public VelMethod getMethod(Object obj, String method, Object[] args, Info info) { return null; } + /** + * @param rs RuntimeServices object assigned during initialization + */ public void setRuntimeServices(RuntimeServices rs) { log = rs.getLog("rendering"); Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/VelMethod.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/VelMethod.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/VelMethod.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/VelMethod.java Mon Mar 11 11:09:53 2019 @@ -39,7 +39,8 @@ public interface VelMethod * @param o * @param params * @return The resulting object. - * @throws IllegalAccessException, InvocationTargetException + * @throws IllegalAccessException + * @throws InvocationTargetException */ Object invoke(Object o, Object[] params) throws IllegalAccessException, InvocationTargetException; Modified: velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/VelPropertySet.java URL: http://svn.apache.org/viewvc/velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/VelPropertySet.java?rev=1855206&r1=1855205&r2=1855206&view=diff ============================================================================== --- velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/VelPropertySet.java (original) +++ velocity/engine/trunk/velocity-engine-core/src/main/java/org/apache/velocity/util/introspection/VelPropertySet.java Mon Mar 11 11:09:53 2019 @@ -36,7 +36,7 @@ public interface VelPropertySet * @param o Object on which the method will be called with the arg * @param arg value to be set * @return the value returned from the set operation (impl specific) - * @throws Exception + * @throws Exception */ Object invoke(Object o, Object arg) throws Exception;
