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-scxml.git
The following commit(s) were added to refs/heads/master by this push:
new e658acac Javadoc
e658acac is described below
commit e658acac55697dd625b9744b4a85cbf5fdde17c2
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 09:09:14 2026 -0400
Javadoc
---
src/main/java/org/apache/commons/scxml2/EvaluatorFactory.java | 2 +-
src/main/java/org/apache/commons/scxml2/EvaluatorProvider.java | 4 ++--
src/main/java/org/apache/commons/scxml2/EventDispatcher.java | 2 +-
src/main/java/org/apache/commons/scxml2/PathResolver.java | 2 +-
.../java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java | 2 +-
.../java/org/apache/commons/scxml2/env/groovy/GroovyEvaluator.java | 2 +-
.../java/org/apache/commons/scxml2/env/javascript/JSEvaluator.java | 2 +-
src/main/java/org/apache/commons/scxml2/env/jexl/JexlEvaluator.java | 2 +-
src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java | 2 +-
src/main/java/org/apache/commons/scxml2/io/SCXMLWriter.java | 2 +-
src/main/java/org/apache/commons/scxml2/model/SCXML.java | 2 +-
src/main/java/org/apache/commons/scxml2/model/TransitionalState.java | 2 +-
src/test/java/org/apache/commons/scxml2/w3c/W3CTests.java | 4 ++--
13 files changed, 15 insertions(+), 15 deletions(-)
diff --git a/src/main/java/org/apache/commons/scxml2/EvaluatorFactory.java
b/src/main/java/org/apache/commons/scxml2/EvaluatorFactory.java
index eee2d413..a1d3aee2 100644
--- a/src/main/java/org/apache/commons/scxml2/EvaluatorFactory.java
+++ b/src/main/java/org/apache/commons/scxml2/EvaluatorFactory.java
@@ -67,7 +67,7 @@ public class EvaluatorFactory {
* <p>If no SCXML document is provided a default Evaluator will be
returned.</p>
*
* @param document The document to return a dedicated Evaluator for. May
be null to retrieve the default Evaluator.
- * @return a new and not sharable Evaluator instance for the provided
document, or a default Evaluator otherwise
+ * @return A new and not sharable Evaluator instance for the provided
document, or a default Evaluator otherwise
* @throws ModelException If the SCXML document datamodel is not supported.
*/
public static Evaluator getEvaluator(final SCXML document) throws
ModelException {
diff --git a/src/main/java/org/apache/commons/scxml2/EvaluatorProvider.java
b/src/main/java/org/apache/commons/scxml2/EvaluatorProvider.java
index a984947f..db8aa3a3 100644
--- a/src/main/java/org/apache/commons/scxml2/EvaluatorProvider.java
+++ b/src/main/java/org/apache/commons/scxml2/EvaluatorProvider.java
@@ -24,7 +24,7 @@ import org.apache.commons.scxml2.model.SCXML;
public interface EvaluatorProvider {
/**
- * @return a default or generic {@link Evaluator} supporting the {@link
#getSupportedDatamodel()}
+ * @return A default or generic {@link Evaluator} supporting the {@link
#getSupportedDatamodel()}
*/
Evaluator getEvaluator();
@@ -36,7 +36,7 @@ public interface EvaluatorProvider {
* </p>
*
* @param document the SCXML document
- * @return a new and not sharable Evaluator instance
+ * @return A new and not sharable Evaluator instance
*/
Evaluator getEvaluator(SCXML document);
diff --git a/src/main/java/org/apache/commons/scxml2/EventDispatcher.java
b/src/main/java/org/apache/commons/scxml2/EventDispatcher.java
index ec894fc6..49485334 100644
--- a/src/main/java/org/apache/commons/scxml2/EventDispatcher.java
+++ b/src/main/java/org/apache/commons/scxml2/EventDispatcher.java
@@ -42,7 +42,7 @@ public interface EventDispatcher {
* the EventDispatcher provides this newInstnace method to allow creating
a new instance without sharing its
* internal state.
*
- * @return a new EventDispatcher instance for usage in an invoked child
statemachine.
+ * @return A new EventDispatcher instance for usage in an invoked child
statemachine.
*/
EventDispatcher newInstance();
diff --git a/src/main/java/org/apache/commons/scxml2/PathResolver.java
b/src/main/java/org/apache/commons/scxml2/PathResolver.java
index 17363fa8..7c59c122 100644
--- a/src/main/java/org/apache/commons/scxml2/PathResolver.java
+++ b/src/main/java/org/apache/commons/scxml2/PathResolver.java
@@ -26,7 +26,7 @@ public interface PathResolver {
* Gets a PathResolver rooted at this context sensitive path.
*
* @param ctxPath Context sensitive path, can be a relative URL
- * @return a new resolver rooted at ctxPath
+ * @return A new resolver rooted at ctxPath
*/
PathResolver getResolver(String ctxPath);
diff --git
a/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
b/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
index 2a9c5703..c1b71c67 100644
--- a/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
+++ b/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
@@ -37,7 +37,7 @@ public class SCInstanceObjectInputStream extends
ObjectInputStream {
* Callback method invoked from {@link
SCInstanceObjectInputStream#resolveClass(ObjectStreamClass)}
*
* @param osc an instance of class ObjectStreamClass
- * @return a Class object corresponding to osc
+ * @return A Class object corresponding to osc
* @throws IOException if an I/O error occurs while reading the
instance of class ObjectStreamClass
* @throws ClassNotFoundException if the class is not found while
reading the instance of class ObjectStreamClass
*/
diff --git
a/src/main/java/org/apache/commons/scxml2/env/groovy/GroovyEvaluator.java
b/src/main/java/org/apache/commons/scxml2/env/groovy/GroovyEvaluator.java
index 46f2169e..8a3df0e8 100644
--- a/src/main/java/org/apache/commons/scxml2/env/groovy/GroovyEvaluator.java
+++ b/src/main/java/org/apache/commons/scxml2/env/groovy/GroovyEvaluator.java
@@ -127,7 +127,7 @@ public class GroovyEvaluator extends AbstractBaseEvaluator {
*
* @param ctx variable context
* @param expr expression
- * @return a result of the evaluation
+ * @return A result of the evaluation
* @throws SCXMLExpressionException For a malformed expression
* @see Evaluator#eval(Context, String)
*/
diff --git
a/src/main/java/org/apache/commons/scxml2/env/javascript/JSEvaluator.java
b/src/main/java/org/apache/commons/scxml2/env/javascript/JSEvaluator.java
index c9c9f63f..cde6dc76 100644
--- a/src/main/java/org/apache/commons/scxml2/env/javascript/JSEvaluator.java
+++ b/src/main/java/org/apache/commons/scxml2/env/javascript/JSEvaluator.java
@@ -292,7 +292,7 @@ public class JSEvaluator extends AbstractBaseEvaluator {
/**
* Creates a child context.
*
- * @return a new child JSContext.
+ * @return A new child JSContext.
*/
@Override
public Context newContext(final Context parent) {
diff --git
a/src/main/java/org/apache/commons/scxml2/env/jexl/JexlEvaluator.java
b/src/main/java/org/apache/commons/scxml2/env/jexl/JexlEvaluator.java
index 1e3007a5..57b7533b 100644
--- a/src/main/java/org/apache/commons/scxml2/env/jexl/JexlEvaluator.java
+++ b/src/main/java/org/apache/commons/scxml2/env/jexl/JexlEvaluator.java
@@ -100,7 +100,7 @@ public class JexlEvaluator extends AbstractBaseEvaluator {
*
* @param ctx variable context
* @param expr expression
- * @return a result of the evaluation
+ * @return A result of the evaluation
* @throws SCXMLExpressionException For a malformed expression
* @see Evaluator#eval(Context, String)
*/
diff --git a/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java
b/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java
index 1c9adadd..a9b098a5 100644
--- a/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java
+++ b/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java
@@ -563,7 +563,7 @@ public final class SCXMLReader {
/**
* @param prefix prefix
* @param localName localName
- * @return a qualified name from a prefix and localName
+ * @return A qualified name from a prefix and localName
*/
private static String createQualifiedName(final String prefix, final
String localName) {
return (prefix != null && !prefix.isEmpty() ? prefix + ":" : "") +
localName;
diff --git a/src/main/java/org/apache/commons/scxml2/io/SCXMLWriter.java
b/src/main/java/org/apache/commons/scxml2/io/SCXMLWriter.java
index 3159aad1..4cf3e4c6 100644
--- a/src/main/java/org/apache/commons/scxml2/io/SCXMLWriter.java
+++ b/src/main/java/org/apache/commons/scxml2/io/SCXMLWriter.java
@@ -269,7 +269,7 @@ public class SCXMLWriter {
/**
* @param prefix prefix
* @param localName localName
- * @return a qualified name from a prefix and localName
+ * @return A qualified name from a prefix and localName
*/
private static String createQualifiedName(final String prefix, final
String localName) {
return (prefix != null && !prefix.isEmpty() ? prefix + ":" : "") +
localName;
diff --git a/src/main/java/org/apache/commons/scxml2/model/SCXML.java
b/src/main/java/org/apache/commons/scxml2/model/SCXML.java
index bff73457..6bd8329f 100644
--- a/src/main/java/org/apache/commons/scxml2/model/SCXML.java
+++ b/src/main/java/org/apache/commons/scxml2/model/SCXML.java
@@ -157,7 +157,7 @@ public class SCXML implements Serializable, Observable {
/**
* Simple unique TransitionTarget id value generation
*
- * @return a unique TransitionTarget id for this SCXML instance
+ * @return A unique TransitionTarget id for this SCXML instance
*/
public final String generateTransitionTargetId() {
return GENERATED_TT_ID_PREFIX +ttNextId++;
diff --git
a/src/main/java/org/apache/commons/scxml2/model/TransitionalState.java
b/src/main/java/org/apache/commons/scxml2/model/TransitionalState.java
index 3781fbac..eb4f0b21 100644
--- a/src/main/java/org/apache/commons/scxml2/model/TransitionalState.java
+++ b/src/main/java/org/apache/commons/scxml2/model/TransitionalState.java
@@ -137,7 +137,7 @@ public abstract class TransitionalState extends
EnterableState {
/**
* Gets the list of history pseudo states for this state.
*
- * @return a list of all history pseudo states contained by a given state
+ * @return A list of all history pseudo states contained by a given state
* (can be empty)
* @see #hasHistory()
* @since 0.7
diff --git a/src/test/java/org/apache/commons/scxml2/w3c/W3CTests.java
b/src/test/java/org/apache/commons/scxml2/w3c/W3CTests.java
index 8319e0c1..447214de 100644
--- a/src/test/java/org/apache/commons/scxml2/w3c/W3CTests.java
+++ b/src/test/java/org/apache/commons/scxml2/w3c/W3CTests.java
@@ -467,7 +467,7 @@ public class W3CTests {
/**
* Unmarshall and return the W3C IRP tests manifest.xml
- * @return an Assertions instance reprenting the W3C IRP tests manifest.xml
+ * @return An Assertions instance reprenting the W3C IRP tests manifest.xml
* @throws Exception
*/
protected Assertions loadAssertions() throws Exception {
@@ -478,7 +478,7 @@ public class W3CTests {
/**
* Loads the tests.xml configuration file into a Tests class configuration
model instance.
- * @return a Tests instance for the tests.xml configuration file.
+ * @return A Tests instance for the tests.xml configuration file.
* @throws Exception
*/
protected Tests loadTests() throws Exception {
