This is an automated email from the ASF dual-hosted git repository.
garydgregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-jelly.git
The following commit(s) were added to refs/heads/master by this push:
new 28b29d82 Javadoc
28b29d82 is described below
commit 28b29d82c7dcde952ddc017505fbfb6bd94ac868
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:08:51 2026 -0400
Javadoc
---
core/src/main/java/org/apache/commons/jelly/JellyContext.java | 6 +++---
core/src/main/java/org/apache/commons/jelly/XMLOutput.java | 2 +-
core/src/main/java/org/apache/commons/jelly/impl/TagScript.java | 4 ++--
.../main/java/org/apache/commons/jelly/servlet/JellyServlet.java | 4 ++--
.../org/apache/commons/jelly/tags/junit/AbstractJellyTestSuite.java | 4 ++--
.../ant/src/main/java/org/apache/commons/jelly/tags/ant/AntTag.java | 2 +-
.../main/java/org/apache/commons/jelly/tags/ant/AntTagLibrary.java | 2 +-
.../main/java/org/apache/commons/jelly/task/AntJellyContext.java | 2 +-
.../src/main/java/org/apache/commons/jelly/tags/http/DeleteTag.java | 2 +-
.../src/main/java/org/apache/commons/jelly/tags/http/GetTag.java | 2 +-
.../src/main/java/org/apache/commons/jelly/tags/http/HeadTag.java | 2 +-
.../java/org/apache/commons/jelly/tags/http/HttpTagLibrary.java | 2 +-
.../java/org/apache/commons/jelly/tags/http/HttpTagSupport.java | 4 ++--
.../java/org/apache/commons/jelly/tags/http/MultipartPostTag.java | 2 +-
.../main/java/org/apache/commons/jelly/tags/http/OptionsTag.java | 2 +-
.../src/main/java/org/apache/commons/jelly/tags/http/PostTag.java | 2 +-
.../src/main/java/org/apache/commons/jelly/tags/http/PutTag.java | 2 +-
.../java/org/apache/commons/jelly/tags/jetty/JettyTagLibrary.java | 2 +-
.../org/apache/commons/jelly/tags/junit/AbstractJellyTestSuite.java | 4 ++--
.../sql/src/main/java/javax/servlet/jsp/jstl/sql/ResultImpl.java | 6 +++---
.../src/main/java/org/apache/commons/jelly/tags/sql/ResultImpl.java | 6 +++---
.../swt/src/main/java/org/apache/commons/jelly/tags/swt/GCTag.java | 2 +-
.../main/java/org/apache/commons/jelly/tags/xml/TransformTag.java | 2 +-
23 files changed, 34 insertions(+), 34 deletions(-)
diff --git a/core/src/main/java/org/apache/commons/jelly/JellyContext.java
b/core/src/main/java/org/apache/commons/jelly/JellyContext.java
index 6c2f08af..7a39925b 100644
--- a/core/src/main/java/org/apache/commons/jelly/JellyContext.java
+++ b/core/src/main/java/org/apache/commons/jelly/JellyContext.java
@@ -254,7 +254,7 @@ public class JellyContext {
}
/**
- * @return a new relative URL from the given root and with the addition of
the
+ * @return A new relative URL from the given root and with the addition of
the
* extra relative URI
*
* @param rootURL is the root context from which the relative URI will be
applied
@@ -551,7 +551,7 @@ public class JellyContext {
}
/**
- * @return an Iterator over the current variable names in this
+ * @return An Iterator over the current variable names in this
* context
*/
public Iterator getVariableNames() {
@@ -566,7 +566,7 @@ public class JellyContext {
}
/**
- * @return a thread pooled XMLParser to avoid the startup overhead
+ * @return A thread pooled XMLParser to avoid the startup overhead
* of the XMLParser
*/
protected XMLParser getXMLParser() {
diff --git a/core/src/main/java/org/apache/commons/jelly/XMLOutput.java
b/core/src/main/java/org/apache/commons/jelly/XMLOutput.java
index 6deb7082..53e9091d 100644
--- a/core/src/main/java/org/apache/commons/jelly/XMLOutput.java
+++ b/core/src/main/java/org/apache/commons/jelly/XMLOutput.java
@@ -190,7 +190,7 @@ public class XMLOutput implements ContentHandler,
LexicalHandler {
* tag-generated XML events. Useful when tag output is not expected
* or not significant.
*
- * @return a no-op XMLOutput
+ * @return A no-op XMLOutput
*/
public static XMLOutput createDummyXMLOutput() {
return new XMLOutput(new DefaultHandler());
diff --git a/core/src/main/java/org/apache/commons/jelly/impl/TagScript.java
b/core/src/main/java/org/apache/commons/jelly/impl/TagScript.java
index 2a566f25..b158a5e9 100644
--- a/core/src/main/java/org/apache/commons/jelly/impl/TagScript.java
+++ b/core/src/main/java/org/apache/commons/jelly/impl/TagScript.java
@@ -77,7 +77,7 @@ public class TagScript implements Script {
private static final Log log = LogFactory.getLog(TagScript.class);
/**
- * @return a new TagScript based on whether
+ * @return A new TagScript based on whether
* the given Tag class is a bean tag or DynaTag
*/
public static TagScript newInstance(final Class tagClass) {
@@ -350,7 +350,7 @@ public class TagScript implements Script {
* in scope in the document where this tag is used which are mapped to
* their namespace URIs.
*
- * @return a Map with the keys are namespace prefixes and the values are
+ * @return A Map with the keys are namespace prefixes and the values are
* namespace URIs.
*/
public synchronized Map getNamespaceContext() {
diff --git
a/core/src/main/java/org/apache/commons/jelly/servlet/JellyServlet.java
b/core/src/main/java/org/apache/commons/jelly/servlet/JellyServlet.java
index 393fa124..66c6ef7d 100644
--- a/core/src/main/java/org/apache/commons/jelly/servlet/JellyServlet.java
+++ b/core/src/main/java/org/apache/commons/jelly/servlet/JellyServlet.java
@@ -53,7 +53,7 @@ public class JellyServlet extends HttpServlet {
* See org.apache.velocity.servlet.VelocityServlet#createContext
* @param req
* @param res
- * @return a new context.
+ * @return A new context.
*/
protected JellyContext createContext(
final HttpServletRequest req,
@@ -153,7 +153,7 @@ public class JellyServlet extends HttpServlet {
*
* See org.apache.velocity.servlet.VelocityServlet#getTemplate
* @param req
- * @return a URL.
+ * @return A URL.
* @throws MalformedURLException
*/
protected URL getScript(final HttpServletRequest req)
diff --git
a/core/src/test/java/org/apache/commons/jelly/tags/junit/AbstractJellyTestSuite.java
b/core/src/test/java/org/apache/commons/jelly/tags/junit/AbstractJellyTestSuite.java
index 74b22e4c..87d6a99a 100644
---
a/core/src/test/java/org/apache/commons/jelly/tags/junit/AbstractJellyTestSuite.java
+++
b/core/src/test/java/org/apache/commons/jelly/tags/junit/AbstractJellyTestSuite.java
@@ -45,7 +45,7 @@ public abstract class AbstractJellyTestSuite {
*
* @param testClass is the test class used to load the script via the
classpath
* @param script is the name of the script, which is typically just a
name, no directory.
- * @return a newly created TestSuite
+ * @return A newly created TestSuite
*/
public static TestSuite createTestSuite(final Class testClass, final
String script) throws Exception {
final URL url = testClass.getResource(script);
@@ -62,7 +62,7 @@ public abstract class AbstractJellyTestSuite {
* Helper method to create a test suite from the given Jelly script
*
* @param script is the URL to the script which should create a TestSuite
- * @return a newly created TestSuite
+ * @return A newly created TestSuite
*/
public static TestSuite createTestSuite(final URL script) throws Exception
{
JellyContext context = new JellyContext(script);
diff --git
a/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/AntTag.java
b/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/AntTag.java
index dcd73942..2bdd1eef 100644
--- a/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/AntTag.java
+++ b/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/AntTag.java
@@ -78,7 +78,7 @@ public class AntTag extends MapTagSupport implements
TaskSource {
}
/**
- * @return an object create with the given constructor and args.
+ * @return An object create with the given constructor and args.
* @param ctor a constructor to use creating the object
* @param args the arguments to pass to the constructor
* @param name the name of the data type being created
diff --git
a/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/AntTagLibrary.java
b/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/AntTagLibrary.java
index 875e6693..09437af2 100644
---
a/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/AntTagLibrary.java
+++
b/jelly-tags/ant/src/main/java/org/apache/commons/jelly/tags/ant/AntTagLibrary.java
@@ -132,7 +132,7 @@ public class AntTagLibrary extends TagLibrary {
}
/**
- * @return a new TagScript for any custom, statically defined tags, like
'fileScanner'
+ * @return A new TagScript for any custom, statically defined tags, like
'fileScanner'
*/
public TagScript createCustomTagScript(final String name, final Attributes
attributes) {
// custom Ant tags
diff --git
a/jelly-tags/ant/src/main/java/org/apache/commons/jelly/task/AntJellyContext.java
b/jelly-tags/ant/src/main/java/org/apache/commons/jelly/task/AntJellyContext.java
index 054587f7..7aabe783 100644
---
a/jelly-tags/ant/src/main/java/org/apache/commons/jelly/task/AntJellyContext.java
+++
b/jelly-tags/ant/src/main/java/org/apache/commons/jelly/task/AntJellyContext.java
@@ -75,7 +75,7 @@ public class AntJellyContext extends JellyContext {
}
/**
- * @return an Iterator over the current variable names in this
+ * @return An Iterator over the current variable names in this
* context
*/
@Override
diff --git
a/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/DeleteTag.java
b/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/DeleteTag.java
index 05c0090a..13e5f38b 100644
---
a/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/DeleteTag.java
+++
b/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/DeleteTag.java
@@ -37,7 +37,7 @@ public class DeleteTag extends HttpTagSupport {
}
/**
- * @return a url method for a get request
+ * @return A url method for a get request
* @throws MalformedURLException when the url is bad
*/
@Override
diff --git
a/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/GetTag.java
b/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/GetTag.java
index 0dfd4005..c647b378 100644
---
a/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/GetTag.java
+++
b/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/GetTag.java
@@ -37,7 +37,7 @@ public class GetTag extends HttpTagSupport {
}
/**
- * @return a url method for a get request
+ * @return A url method for a get request
* @throws MalformedURLException when the url is bad
*/
@Override
diff --git
a/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/HeadTag.java
b/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/HeadTag.java
index 925a06a4..8b8e7ead 100644
---
a/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/HeadTag.java
+++
b/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/HeadTag.java
@@ -37,7 +37,7 @@ public class HeadTag extends HttpTagSupport {
}
/**
- * @return a url method for a Head request
+ * @return A url method for a Head request
* @throws MalformedURLException when the url is bad
*/
@Override
diff --git
a/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/HttpTagLibrary.java
b/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/HttpTagLibrary.java
index 007fa883..0fb8c879 100644
---
a/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/HttpTagLibrary.java
+++
b/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/HttpTagLibrary.java
@@ -46,7 +46,7 @@ public class HttpTagLibrary extends TagLibrary {
/**
* @see TagLibrary#getTagClasses()
- * @return a Map of tag name to tag class
+ * @return A Map of tag name to tag class
*/
@Override
public Map getTagClasses() {
diff --git
a/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/HttpTagSupport.java
b/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/HttpTagSupport.java
index 6bb8d433..a2f4a7b9 100644
---
a/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/HttpTagSupport.java
+++
b/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/HttpTagSupport.java
@@ -128,7 +128,7 @@ public abstract class HttpTagSupport extends TagSupport {
* retrieve the {@link HttpUrlMethod method} from the subclass and
* configure it ready for execution
*
- * @return a configured {@link HttpUrlMethod method}
+ * @return A configured {@link HttpUrlMethod method}
* @throws MalformedURLException when retrieving the URL fails
*/
private HttpMethod getConfiguredHttpMethod() throws
@@ -178,7 +178,7 @@ public abstract class HttpTagSupport extends TagSupport {
* A method that must be implemented by subclasses to provide the
* {@link HttpMethod url method} implementation
*
- * @return a HttpUrlMethod implementation
+ * @return A HttpUrlMethod implementation
* @throws MalformedURLException when the {@link #getUri() uri} or
* {@link #getPath() path} is invalid
*/
diff --git
a/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/MultipartPostTag.java
b/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/MultipartPostTag.java
index 81dfac5d..3d5592a4 100644
---
a/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/MultipartPostTag.java
+++
b/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/MultipartPostTag.java
@@ -65,7 +65,7 @@ public class MultipartPostTag extends PostTag {
/**
* Gets a {@link HttpMethod method} to be used for multi-part post'ing
*
- * @return a HttpUrlMethod implementation
+ * @return A HttpUrlMethod implementation
* @throws MalformedURLException when the {@link #getUri() URI} or
* {@link #getPath() path} is invalid
*/
diff --git
a/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/OptionsTag.java
b/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/OptionsTag.java
index 58fa3ff6..d92b0fc0 100644
---
a/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/OptionsTag.java
+++
b/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/OptionsTag.java
@@ -37,7 +37,7 @@ public class OptionsTag extends HttpTagSupport {
}
/**
- * @return a url method for an options request
+ * @return A url method for an options request
* @throws MalformedURLException when the url is bad
*/
@Override
diff --git
a/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/PostTag.java
b/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/PostTag.java
index 8511d1a2..41a077bd 100644
---
a/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/PostTag.java
+++
b/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/PostTag.java
@@ -38,7 +38,7 @@ public class PostTag extends HttpTagSupport {
/**
* Gets a {@link HttpMethod method} to be used for post'ing
*
- * @return a HttpUrlMethod implementation
+ * @return A HttpUrlMethod implementation
* @throws MalformedURLException when the {@link #getUri() URI} or
* {@link #getPath() path} is invalid
*/
diff --git
a/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/PutTag.java
b/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/PutTag.java
index d1524f68..c9e176a8 100644
---
a/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/PutTag.java
+++
b/jelly-tags/http/src/main/java/org/apache/commons/jelly/tags/http/PutTag.java
@@ -48,7 +48,7 @@ public class PutTag extends HttpTagSupport {
/**
* Gets a {@link HttpMethod method} to be used for put'ing
*
- * @return a HttpMethod implementation
+ * @return A HttpMethod implementation
* @throws MalformedURLException when the {@link #getUri() URI} or
* {@link #getPath() path} is invalid
*/
diff --git
a/jelly-tags/jetty/src/main/java/org/apache/commons/jelly/tags/jetty/JettyTagLibrary.java
b/jelly-tags/jetty/src/main/java/org/apache/commons/jelly/tags/jetty/JettyTagLibrary.java
index de97bf41..e8a4cc36 100644
---
a/jelly-tags/jetty/src/main/java/org/apache/commons/jelly/tags/jetty/JettyTagLibrary.java
+++
b/jelly-tags/jetty/src/main/java/org/apache/commons/jelly/tags/jetty/JettyTagLibrary.java
@@ -51,7 +51,7 @@ public class JettyTagLibrary extends TagLibrary {
/**
* @see TagLibrary#getTagClasses()
- * @return a Map of tag name to tag class
+ * @return A Map of tag name to tag class
*/
@Override
public Map getTagClasses() {
diff --git
a/jelly-tags/junit/src/main/java/org/apache/commons/jelly/tags/junit/AbstractJellyTestSuite.java
b/jelly-tags/junit/src/main/java/org/apache/commons/jelly/tags/junit/AbstractJellyTestSuite.java
index 74b22e4c..87d6a99a 100644
---
a/jelly-tags/junit/src/main/java/org/apache/commons/jelly/tags/junit/AbstractJellyTestSuite.java
+++
b/jelly-tags/junit/src/main/java/org/apache/commons/jelly/tags/junit/AbstractJellyTestSuite.java
@@ -45,7 +45,7 @@ public abstract class AbstractJellyTestSuite {
*
* @param testClass is the test class used to load the script via the
classpath
* @param script is the name of the script, which is typically just a
name, no directory.
- * @return a newly created TestSuite
+ * @return A newly created TestSuite
*/
public static TestSuite createTestSuite(final Class testClass, final
String script) throws Exception {
final URL url = testClass.getResource(script);
@@ -62,7 +62,7 @@ public abstract class AbstractJellyTestSuite {
* Helper method to create a test suite from the given Jelly script
*
* @param script is the URL to the script which should create a TestSuite
- * @return a newly created TestSuite
+ * @return A newly created TestSuite
*/
public static TestSuite createTestSuite(final URL script) throws Exception
{
JellyContext context = new JellyContext(script);
diff --git
a/jelly-tags/sql/src/main/java/javax/servlet/jsp/jstl/sql/ResultImpl.java
b/jelly-tags/sql/src/main/java/javax/servlet/jsp/jstl/sql/ResultImpl.java
index 8bf4ece4..30b7d720 100644
--- a/jelly-tags/sql/src/main/java/javax/servlet/jsp/jstl/sql/ResultImpl.java
+++ b/jelly-tags/sql/src/main/java/javax/servlet/jsp/jstl/sql/ResultImpl.java
@@ -101,7 +101,7 @@ final class ResultImpl implements Result {
* the names of the columns arranged in the same order as in
* the getRowsByIndex() method.
*
- * @return an array of String[]
+ * @return An array of String[]
*/
@Override
public String[] getColumnNames() {
@@ -129,7 +129,7 @@ final class ResultImpl implements Result {
* Comparator so the key is the case insensitive representation
* of the ColumnName.
*
- * @return an array of Map, or null if there are no rows
+ * @return An array of Map, or null if there are no rows
*/
@Override
public SortedMap[] getRows() {
@@ -146,7 +146,7 @@ final class ResultImpl implements Result {
* designates the Row, the second the Column. The array
* stores the value at the specified row and column.
*
- * @return an array of Object[], or null if there are no rows
+ * @return An array of Object[], or null if there are no rows
*/
@Override
public Object[][] getRowsByIndex() {
diff --git
a/jelly-tags/sql/src/main/java/org/apache/commons/jelly/tags/sql/ResultImpl.java
b/jelly-tags/sql/src/main/java/org/apache/commons/jelly/tags/sql/ResultImpl.java
index b416a5d0..970f5fe4 100644
---
a/jelly-tags/sql/src/main/java/org/apache/commons/jelly/tags/sql/ResultImpl.java
+++
b/jelly-tags/sql/src/main/java/org/apache/commons/jelly/tags/sql/ResultImpl.java
@@ -153,7 +153,7 @@ public class ResultImpl implements Result {
* the names of the columns arranged in the same order as in
* the getRowsByIndex() method.
*
- * @return an array of String[]
+ * @return An array of String[]
*/
@Override
public String[] getColumnNames() {
@@ -181,7 +181,7 @@ public class ResultImpl implements Result {
* Comparator so the key is the case insensitive representation
* of the ColumnName.
*
- * @return an array of Map, or null if there are no rows
+ * @return An array of Map, or null if there are no rows
*/
@Override
public SortedMap[] getRows() {
@@ -198,7 +198,7 @@ public class ResultImpl implements Result {
* designates the Row, the second the Column. The array
* stores the value at the specified row and column.
*
- * @return an array of Object[], or null if there are no rows
+ * @return An array of Object[], or null if there are no rows
*/
@Override
public Object[][] getRowsByIndex() {
diff --git
a/jelly-tags/swt/src/main/java/org/apache/commons/jelly/tags/swt/GCTag.java
b/jelly-tags/swt/src/main/java/org/apache/commons/jelly/tags/swt/GCTag.java
index 54d263b7..997419e5 100644
--- a/jelly-tags/swt/src/main/java/org/apache/commons/jelly/tags/swt/GCTag.java
+++ b/jelly-tags/swt/src/main/java/org/apache/commons/jelly/tags/swt/GCTag.java
@@ -67,7 +67,7 @@ public class GCTag extends TagSupport {
/**
* Obtain the {@link Drawable} name for this {@link GC}.
*
- * @return a {@link GC} {@link Drawable}
+ * @return A {@link GC} {@link Drawable}
*/
public Drawable getDrawable() {
return this.drawable;
diff --git
a/jelly-tags/xml/src/main/java/org/apache/commons/jelly/tags/xml/TransformTag.java
b/jelly-tags/xml/src/main/java/org/apache/commons/jelly/tags/xml/TransformTag.java
index 812b745b..348fe06c 100644
---
a/jelly-tags/xml/src/main/java/org/apache/commons/jelly/tags/xml/TransformTag.java
+++
b/jelly-tags/xml/src/main/java/org/apache/commons/jelly/tags/xml/TransformTag.java
@@ -429,7 +429,7 @@ public class TransformTag extends ParseTag {
* Creates a new URI Resolver so that URIs inside the XSLT document can be
* resolved using the JellyContext
*
- * @return a URI Resolver for the JellyContext
+ * @return A URI Resolver for the JellyContext
*/
protected URIResolver createURIResolver() {
return (href, base) -> {
