This is an automated email from the ASF dual-hosted git repository. ggregory pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/commons-jelly.git
commit 798ea102e964bb88daa50cc44be1e3c1a5850360 Author: Gary D. Gregory <garydgreg...@gmail.com> AuthorDate: Sun May 4 09:38:56 2025 -0400 Javadoc and comment typos in Java files --- .../apache/commons/jelly/tags/jaxme/GeneratorTag.java | 2 +- .../apache/commons/jelly/tags/jaxme/MarshallTag.java | 2 +- .../apache/commons/jelly/tags/jaxme/UnmarshallTag.java | 6 +++--- .../commons/jelly/tags/jetty/SecurityHandlerTag.java | 8 ++++---- .../commons/jelly/tags/threads/RunnableStatus.java | 2 +- .../org/apache/commons/jelly/tags/xml/ParseTag.java | 4 ++-- .../java/org/apache/commons/jelly/tags/xml/SetTag.java | 2 +- .../org/apache/commons/jelly/tags/xml/SortTag.java | 2 +- .../apache/commons/jelly/tags/xml/TransformTag.java | 18 +++++++++--------- 9 files changed, 23 insertions(+), 23 deletions(-) diff --git a/jelly-tags/jaxme/src/main/java/org/apache/commons/jelly/tags/jaxme/GeneratorTag.java b/jelly-tags/jaxme/src/main/java/org/apache/commons/jelly/tags/jaxme/GeneratorTag.java index 1ba65ee4..4b2ab2eb 100644 --- a/jelly-tags/jaxme/src/main/java/org/apache/commons/jelly/tags/jaxme/GeneratorTag.java +++ b/jelly-tags/jaxme/src/main/java/org/apache/commons/jelly/tags/jaxme/GeneratorTag.java @@ -33,7 +33,7 @@ import org.apache.ws.jaxme.js.JavaSourceFactory; /** * Generates java objects using JaxMe. - * This object can be marshalled into xml and the results unmarshalled + * This object can be marshalled into XML and the results unmarshalled * using JaxMe. */ public class GeneratorTag extends TagSupport { diff --git a/jelly-tags/jaxme/src/main/java/org/apache/commons/jelly/tags/jaxme/MarshallTag.java b/jelly-tags/jaxme/src/main/java/org/apache/commons/jelly/tags/jaxme/MarshallTag.java index 91f51cce..4c500d33 100644 --- a/jelly-tags/jaxme/src/main/java/org/apache/commons/jelly/tags/jaxme/MarshallTag.java +++ b/jelly-tags/jaxme/src/main/java/org/apache/commons/jelly/tags/jaxme/MarshallTag.java @@ -58,7 +58,7 @@ public class MarshallTag extends TagSupport { } /** - * Defines the object to be unmarshalled into xml by specifying a jelly variable name. + * Defines the object to be unmarshalled into XML by specifying a jelly variable name. */ public void setObject(Object object) { this.object = object; diff --git a/jelly-tags/jaxme/src/main/java/org/apache/commons/jelly/tags/jaxme/UnmarshallTag.java b/jelly-tags/jaxme/src/main/java/org/apache/commons/jelly/tags/jaxme/UnmarshallTag.java index 421c2b00..ebb35c5a 100644 --- a/jelly-tags/jaxme/src/main/java/org/apache/commons/jelly/tags/jaxme/UnmarshallTag.java +++ b/jelly-tags/jaxme/src/main/java/org/apache/commons/jelly/tags/jaxme/UnmarshallTag.java @@ -38,9 +38,9 @@ import org.apache.ws.jaxme.generator.impl.GeneratorImpl; import org.xml.sax.SAXException; /** - * <p>Unmarshalls xml documents into java objects.</p> + * <p>Unmarshalls XML documents into java objects.</p> * <p> - * This tag unmarshalls the xml content contained + * This tag unmarshalls the XML content contained * into the JaxMe generated java objects in the packages specified. * </p> */ @@ -54,7 +54,7 @@ public class UnmarshallTag extends TagSupport { } /** - * Defines the generated objects to which the xml should be unmarshalled. + * Defines the generated objects to which the XML should be unmarshalled. */ public void setPackages(String packages) { this.packages = packages; diff --git a/jelly-tags/jetty/src/main/java/org/apache/commons/jelly/tags/jetty/SecurityHandlerTag.java b/jelly-tags/jetty/src/main/java/org/apache/commons/jelly/tags/jetty/SecurityHandlerTag.java index 19c0d561..f90fdc9c 100644 --- a/jelly-tags/jetty/src/main/java/org/apache/commons/jelly/tags/jetty/SecurityHandlerTag.java +++ b/jelly-tags/jetty/src/main/java/org/apache/commons/jelly/tags/jetty/SecurityHandlerTag.java @@ -149,10 +149,10 @@ public class SecurityHandlerTag extends TagSupport { * This is the code from Jetty's WebApplicationContext * with the HttpContextTag parameter added * - * Process a parsed xml node to setup the security constraints + * Process a parsed XML node to setup the security constraints * for an http server * - * @param node the parsed xml starting node of the constraints + * @param node the parsed XML starting node of the constraints * @param httpContext the tag to add the security constraint to */ protected void initSecurityConstraint(XmlParser.Node node, @@ -220,10 +220,10 @@ public class SecurityHandlerTag extends TagSupport { * with the HttpContextTag parameter added * * - * Process a parsed xml node to setup the authenticator and realm + * Process a parsed XML node to setup the authenticator and realm * for an http server * - * @param node the parsed xml starting node of the login configuration + * @param node the parsed XML starting node of the login configuration * @param httpContext the tag to add the authenticator and realm to */ protected void initLoginConfig(XmlParser.Node node, diff --git a/jelly-tags/threads/src/main/java/org/apache/commons/jelly/tags/threads/RunnableStatus.java b/jelly-tags/threads/src/main/java/org/apache/commons/jelly/tags/threads/RunnableStatus.java index d8edf6e1..2c9fde4c 100644 --- a/jelly-tags/threads/src/main/java/org/apache/commons/jelly/tags/threads/RunnableStatus.java +++ b/jelly-tags/threads/src/main/java/org/apache/commons/jelly/tags/threads/RunnableStatus.java @@ -96,7 +96,7 @@ public class RunnableStatus { /** * Used to get the status code from a string representation. Mainly used for - * xml parsing. + * XML parsing. * @param status The status string rep. * @return The status enum value */ diff --git a/jelly-tags/xml/src/main/java/org/apache/commons/jelly/tags/xml/ParseTag.java b/jelly-tags/xml/src/main/java/org/apache/commons/jelly/tags/xml/ParseTag.java index b85608ba..14c43af7 100644 --- a/jelly-tags/xml/src/main/java/org/apache/commons/jelly/tags/xml/ParseTag.java +++ b/jelly-tags/xml/src/main/java/org/apache/commons/jelly/tags/xml/ParseTag.java @@ -26,14 +26,14 @@ import org.dom4j.io.SAXReader; /** A tag which parses some XML and defines a variable with the parsed Document. * The XML can either be specified as its body or can be passed in via the - * xml property which can be a Reader, InputStream, URL or String URI. + * XML property which can be a Reader, InputStream, URL or String URI. */ public class ParseTag extends ParseTagSupport { /** The Log to which logging calls will be made. */ private static final Log log = LogFactory.getLog(ParseTag.class); - /** The xml to parse, either a String URI, a Reader or InputStream */ + /** The XML to parse, either a String URI, a Reader or InputStream */ private Object xml; // Optional properties not defined in JSTL diff --git a/jelly-tags/xml/src/main/java/org/apache/commons/jelly/tags/xml/SetTag.java b/jelly-tags/xml/src/main/java/org/apache/commons/jelly/tags/xml/SetTag.java index 3952d0e3..207c42c2 100644 --- a/jelly-tags/xml/src/main/java/org/apache/commons/jelly/tags/xml/SetTag.java +++ b/jelly-tags/xml/src/main/java/org/apache/commons/jelly/tags/xml/SetTag.java @@ -40,7 +40,7 @@ import java.util.ListIterator; * This function creates a variable of type {@link List} or {@link org.dom4j.Node} * (for example {@link org.dom4j.Element} or {@link org.dom4j.Attribute}). * Thus, the variable created from xml:set can be - * used from the other xml library functions. + * used from the other XML library functions. */ public class SetTag extends XPathTagSupport { diff --git a/jelly-tags/xml/src/main/java/org/apache/commons/jelly/tags/xml/SortTag.java b/jelly-tags/xml/src/main/java/org/apache/commons/jelly/tags/xml/SortTag.java index 516df814..473e4f5d 100644 --- a/jelly-tags/xml/src/main/java/org/apache/commons/jelly/tags/xml/SortTag.java +++ b/jelly-tags/xml/src/main/java/org/apache/commons/jelly/tags/xml/SortTag.java @@ -28,7 +28,7 @@ import org.jaxen.JaxenException; import java.util.List; import java.util.Collections; -/** A tag that can sort a list of xml nodes via an xpath expression. +/** A tag that can sort a list of XML nodes via an xpath expression. */ public class SortTag extends XPathTagSupport { 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 2785b02f..11d97e2f 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 @@ -69,7 +69,7 @@ import org.xml.sax.helpers.XMLReaderFactory; /** A tag which parses some XML, applies an xslt transform to it * and defines a variable with the transformed Document. * The XML can either be specified as its body or can be passed in via the - * xml property which can be a Reader, InputStream, URL or String URI. + * XML property which can be a Reader, InputStream, URL or String URI. * * The XSL can be passed in via the * xslt property which can be a Reader, InputStream, URL or String URI. @@ -106,7 +106,7 @@ public class TransformTag extends ParseTag { /** * Process this tag instance * - * @param output The pipeline for xml events + * @param output The pipeline for XML events * @throws MissingAttributeException Thrown when required attributes are missing */ @Override @@ -240,7 +240,7 @@ public class TransformTag extends ParseTag { /** * Factory method to create a new XMLReader for this tag * so that the input of the XSLT transform comes from - * either the xml var, the nested tag or the tag body. + * either the XML var, the nested tag or the tag body. * * @return XMLReader for the transform input * @throws SAXException @@ -250,7 +250,7 @@ public class TransformTag extends ParseTag { protected XMLReader createXMLReader() throws SAXException { XMLReader xmlReader = null; Object xmlReaderSourceObj = this.getXml(); - // if no xml source specified then get from body + // if no XML source specified then get from body // otherwise convert it to a SAX source if (null == xmlReaderSourceObj) { xmlReader = new TagBodyXMLReader(this); @@ -263,16 +263,16 @@ public class TransformTag extends ParseTag { } /** - * Helper method to get the appropriate xml input source + * Helper method to get the appropriate XML input source * so that the input of the XSLT transform comes from - * either the xml var, the nested tag or the tag body. + * either the XML var, the nested tag or the tag body. * * @return InputSource for the transform input */ protected InputSource getXMLInputSource() { InputSource xmlInputSource = null; Object xmlInputSourceObj = this.getXml(); - // if no xml source specified then get from tag body + // if no XML source specified then get from tag body // otherwise convert it to an input source if (null == xmlInputSourceObj) { xmlInputSource = new TagBodyInputSource(); @@ -303,7 +303,7 @@ public class TransformTag extends ParseTag { } /** - * Helper method to get an xml input source for the supplied object + * Helper method to get an XML input source for the supplied object * * @return InputSource for the object or null */ @@ -485,7 +485,7 @@ public class TransformTag extends ParseTag { /** * Helper method to determine if nested body needs to be parsed by (an - * xml parser, i.e. its only text) to generate SAX events or not + * XML parser, i.e. its only text) to generate SAX events or not * * @return True if tag body should be parsed or false if invoked only * @throws JellyTagException