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 cc5233d7 Javadoc
cc5233d7 is described below
commit cc5233d7c2a21613ff44823695a9c7672ebd4ef8
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 11:22:50 2026 -0400
Javadoc
---
.../commons/scxml2/ActionExecutionContext.java | 2 +-
.../java/org/apache/commons/scxml2/Evaluator.java | 2 +-
.../apache/commons/scxml2/EvaluatorProvider.java | 2 +-
.../org/apache/commons/scxml2/EventDispatcher.java | 2 +-
.../java/org/apache/commons/scxml2/SCInstance.java | 2 +-
.../scxml2/SCInstanceObjectInputStream.java | 2 +-
.../org/apache/commons/scxml2/SCXMLExecutor.java | 4 +--
.../apache/commons/scxml2/SCXMLIOProcessor.java | 2 +-
.../org/apache/commons/scxml2/SCXMLSemantics.java | 2 +-
.../apache/commons/scxml2/SCXMLSystemContext.java | 2 +-
.../scxml2/env/groovy/GroovySCXMLScript.java | 4 +--
.../commons/scxml2/env/javascript/JSBindings.java | 6 ++---
.../commons/scxml2/env/jexl/JexlBuiltin.java | 2 +-
.../org/apache/commons/scxml2/invoke/Invoker.java | 2 +-
.../apache/commons/scxml2/io/ContentParser.java | 2 +-
.../org/apache/commons/scxml2/io/SCXMLReader.java | 2 +-
.../org/apache/commons/scxml2/model/Cancel.java | 2 +-
.../commons/scxml2/model/ContentContainer.java | 2 +-
.../commons/scxml2/model/CustomActionWrapper.java | 2 +-
.../org/apache/commons/scxml2/model/DoneData.java | 2 +-
.../commons/scxml2/model/EnterableState.java | 2 +-
.../org/apache/commons/scxml2/model/Invoke.java | 6 ++---
.../commons/scxml2/model/ModelException.java | 8 +++---
.../org/apache/commons/scxml2/model/Parallel.java | 2 +-
.../commons/scxml2/model/PayloadBuilder.java | 22 ++++++++--------
.../java/org/apache/commons/scxml2/model/Send.java | 4 +--
.../commons/scxml2/model/SimpleTransition.java | 4 +--
.../org/apache/commons/scxml2/model/State.java | 2 +-
.../apache/commons/scxml2/model/Transition.java | 2 +-
.../commons/scxml2/model/TransitionTarget.java | 4 +--
.../commons/scxml2/model/TransitionalState.java | 2 +-
.../scxml2/semantics/SCXMLSemanticsImpl.java | 30 +++++++++++-----------
.../commons/scxml2/test/StandaloneUtils.java | 2 +-
.../org/apache/commons/scxml2/w3c/W3CTests.java | 20 +++++++--------
34 files changed, 79 insertions(+), 79 deletions(-)
diff --git
a/src/main/java/org/apache/commons/scxml2/ActionExecutionContext.java
b/src/main/java/org/apache/commons/scxml2/ActionExecutionContext.java
index f1e50e38..17481412 100644
--- a/src/main/java/org/apache/commons/scxml2/ActionExecutionContext.java
+++ b/src/main/java/org/apache/commons/scxml2/ActionExecutionContext.java
@@ -48,7 +48,7 @@ public class ActionExecutionContext {
}
/**
- * @param state an EnterableState
+ * @param state An EnterableState
* @return The context for an EnterableState
*/
public Context getContext(final EnterableState state) {
diff --git a/src/main/java/org/apache/commons/scxml2/Evaluator.java
b/src/main/java/org/apache/commons/scxml2/Evaluator.java
index 05743d42..7dc893fd 100644
--- a/src/main/java/org/apache/commons/scxml2/Evaluator.java
+++ b/src/main/java/org/apache/commons/scxml2/Evaluator.java
@@ -53,7 +53,7 @@ public interface Evaluator {
*
* @param ctx variable context
* @param location location expression
- * @param data the data to assign.
+ * @param data The data to assign.
* @throws SCXMLExpressionException A malformed expression exception
*/
void evalAssign(Context ctx, String location, Object data)
diff --git a/src/main/java/org/apache/commons/scxml2/EvaluatorProvider.java
b/src/main/java/org/apache/commons/scxml2/EvaluatorProvider.java
index db8aa3a3..cf312e15 100644
--- a/src/main/java/org/apache/commons/scxml2/EvaluatorProvider.java
+++ b/src/main/java/org/apache/commons/scxml2/EvaluatorProvider.java
@@ -35,7 +35,7 @@ public interface EvaluatorProvider {
* Evaluator may not be shareable and reusable for other SCXML documents.
* </p>
*
- * @param document the SCXML document
+ * @param document The SCXML document
* @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 49485334..3f299f80 100644
--- a/src/main/java/org/apache/commons/scxml2/EventDispatcher.java
+++ b/src/main/java/org/apache/commons/scxml2/EventDispatcher.java
@@ -49,7 +49,7 @@ public interface EventDispatcher {
/**
* Send this message to the target.
*
- * @param ioProcessors the available SCXMLIOProcessors, the same map as
the SCXML system variable _ioprocessors
+ * @param ioProcessors The available SCXMLIOProcessors, the same map as
the SCXML system variable _ioprocessors
* @param id The ID of the send message
* @param target An expression returning the target location of the event
* @param type The type of the Event I/O Processor that the event should
diff --git a/src/main/java/org/apache/commons/scxml2/SCInstance.java
b/src/main/java/org/apache/commons/scxml2/SCInstance.java
index f894534c..ee434613 100644
--- a/src/main/java/org/apache/commons/scxml2/SCInstance.java
+++ b/src/main/java/org/apache/commons/scxml2/SCInstance.java
@@ -497,7 +497,7 @@ public class SCInstance implements Serializable {
/**
* Sets the I/O Processor for the internal event queue
*
- * @param internalIOProcessor the I/O Processor
+ * @param internalIOProcessor The I/O Processor
*/
protected void setInternalIOProcessor(final SCXMLIOProcessor
internalIOProcessor) {
this.internalIOProcessor = internalIOProcessor;
diff --git
a/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
b/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
index c1b71c67..84da7890 100644
--- a/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
+++ b/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
@@ -36,7 +36,7 @@ public class SCInstanceObjectInputStream extends
ObjectInputStream {
/**
* Callback method invoked from {@link
SCInstanceObjectInputStream#resolveClass(ObjectStreamClass)}
*
- * @param osc an instance of class ObjectStreamClass
+ * @param osc An instance of class ObjectStreamClass
* @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/SCXMLExecutor.java
b/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
index e3321fa8..43de0eaa 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
@@ -110,7 +110,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
/**
* Constructor using a parent SCXMLExecutor
*
- * @param parentSCXMLExecutor the parent SCXMLExecutor
+ * @param parentSCXMLExecutor The parent SCXMLExecutor
* @param invokeId SCXML invoke id
* @param scxml {@link SCXML} instance
* @throws ModelException if the internal {@link SCInstance} is already
initialized
@@ -130,7 +130,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
* No processing of the vent will be done, until the next triggerEvent
methods is invoked.
* </p>
*
- * @param evt an external event
+ * @param evt An external event
*/
@Override
public void addEvent(final TriggerEvent evt) {
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLIOProcessor.java
b/src/main/java/org/apache/commons/scxml2/SCXMLIOProcessor.java
index bf29e85f..5466ebea 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLIOProcessor.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLIOProcessor.java
@@ -55,7 +55,7 @@ public interface SCXMLIOProcessor {
/**
* Send an event into the SCXML processor queue
*
- * @param event the event to send
+ * @param event The event to send
*/
void addEvent(TriggerEvent event);
}
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLSemantics.java
b/src/main/java/org/apache/commons/scxml2/SCXMLSemantics.java
index 32b99773..5bf6883b 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLSemantics.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLSemantics.java
@@ -143,7 +143,7 @@ public interface SCXMLSemantics {
* {@link SCXMLExecutor#setConfiguration(java.util.Set)}.
* </p>
*
- * @param states a set of states
+ * @param states A set of states
* @param errRep ErrorReporter to report detailed error info if needed
* @return true if a given state configuration is legal, false otherwise
*/
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
b/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
index eaa709af..7dbaea81 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
@@ -156,7 +156,7 @@ public class SCXMLSystemContext implements Context,
Serializable {
/**
* Initialize or replace systemContext
*
- * @param systemContext the system context to set
+ * @param systemContext The system context to set
* @throws NullPointerException if systemContext == null
*/
void setSystemContext(final Context systemContext) {
diff --git
a/src/main/java/org/apache/commons/scxml2/env/groovy/GroovySCXMLScript.java
b/src/main/java/org/apache/commons/scxml2/env/groovy/GroovySCXMLScript.java
index 3ff701e4..3f8fbf79 100644
--- a/src/main/java/org/apache/commons/scxml2/env/groovy/GroovySCXMLScript.java
+++ b/src/main/java/org/apache/commons/scxml2/env/groovy/GroovySCXMLScript.java
@@ -53,7 +53,7 @@ public abstract class GroovySCXMLScript extends Script {
* To work around this, the custom {@link #var(String)} function is
available.
* </p>
*
- * @param obj the object to check if it is empty
+ * @param obj The object to check if it is empty
* @return true if the object is empty, false otherwise
*/
public boolean empty(final Object obj) {
@@ -99,7 +99,7 @@ public abstract class GroovySCXMLScript extends Script {
* See for more information: <a
href="https://docs.codehaus.org/display/GROOVY/Operators#Operators-SafeNavigationOperator(?.)">Groovy
SafeNavigationOperator</a>
* </p>
*
- * @param property the name of variable to check if it exists
+ * @param property The name of variable to check if it exists
* @return true if the variable exists, false otherwise
*/
public boolean var(final String property) {
diff --git
a/src/main/java/org/apache/commons/scxml2/env/javascript/JSBindings.java
b/src/main/java/org/apache/commons/scxml2/env/javascript/JSBindings.java
index fb43ac9b..2e1a66ff 100644
--- a/src/main/java/org/apache/commons/scxml2/env/javascript/JSBindings.java
+++ b/src/main/java/org/apache/commons/scxml2/env/javascript/JSBindings.java
@@ -122,7 +122,7 @@ public class JSBindings implements Bindings {
/**
* Sets all entries in the provided map via {@link #put(String, Object)}
*
- * @param toMerge the map of variables to merge
+ * @param toMerge The map of variables to merge
*/
@Override
public void putAll(final Map<? extends String, ?> toMerge) {
@@ -134,7 +134,7 @@ public class JSBindings implements Bindings {
/**
* Removes the named variable from the contained SCXML context.
*
- * @param name the variable name
+ * @param name The variable name
*/
@Override
public Object remove(final Object name) {
@@ -144,7 +144,7 @@ public class JSBindings implements Bindings {
/**
* Sets or update the SCXML context delegate
*
- * @param jsContext the SCXML context to use for script variables.
+ * @param jsContext The SCXML context to use for script variables.
* @throws IllegalArgumentException Thrown if {@code jsContext} is {@code
null}.
*/
public void setContext(final JSContext jsContext) {
diff --git a/src/main/java/org/apache/commons/scxml2/env/jexl/JexlBuiltin.java
b/src/main/java/org/apache/commons/scxml2/env/jexl/JexlBuiltin.java
index 0221df48..79a10597 100644
--- a/src/main/java/org/apache/commons/scxml2/env/jexl/JexlBuiltin.java
+++ b/src/main/java/org/apache/commons/scxml2/env/jexl/JexlBuiltin.java
@@ -31,7 +31,7 @@ public final class JexlBuiltin {
/**
* Creates a new instance, wraps the context.
*
- * @param ctxt the context in use
+ * @param ctxt The context in use
*/
public JexlBuiltin(final JexlContext ctxt) {
context = ctxt;
diff --git a/src/main/java/org/apache/commons/scxml2/invoke/Invoker.java
b/src/main/java/org/apache/commons/scxml2/invoke/Invoker.java
index d5c4b74e..af664ca0 100644
--- a/src/main/java/org/apache/commons/scxml2/invoke/Invoker.java
+++ b/src/main/java/org/apache/commons/scxml2/invoke/Invoker.java
@@ -138,7 +138,7 @@ public interface Invoker {
/**
* Sets the parent SCXMLExecutor through which this Invoker is initiated
*
- * @param scxmlExecutor the parent SCXMLExecutor
+ * @param scxmlExecutor The parent SCXMLExecutor
*/
void setParentSCXMLExecutor(SCXMLExecutor scxmlExecutor);
}
diff --git a/src/main/java/org/apache/commons/scxml2/io/ContentParser.java
b/src/main/java/org/apache/commons/scxml2/io/ContentParser.java
index 963c3ede..fb89667d 100644
--- a/src/main/java/org/apache/commons/scxml2/io/ContentParser.java
+++ b/src/main/java/org/apache/commons/scxml2/io/ContentParser.java
@@ -171,7 +171,7 @@ public class ContentParser {
* <li>otherwise the content will be treated (cleaned) as a
space-normalized string literal</li>
* </ul>
*
- * @param content the content to parse
+ * @param content The content to parse
* @return The parsed content object
* @throws IOException In case of parsing exceptions
*/
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 a9b098a5..52c0cde5 100644
--- a/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java
+++ b/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java
@@ -2865,7 +2865,7 @@ public final class SCXMLReader {
/**
* Advances the XMLStreamReader until after the end of the current
element: all children will be skipped as well
*
- * @param reader the reader
+ * @param reader The reader
* @throws XMLStreamException
*/
private static void skipToEndElement(final XMLStreamReader reader) throws
XMLStreamException {
diff --git a/src/main/java/org/apache/commons/scxml2/model/Cancel.java
b/src/main/java/org/apache/commons/scxml2/model/Cancel.java
index 04f6abdf..cafe571e 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Cancel.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Cancel.java
@@ -100,7 +100,7 @@ public class Cancel extends Action {
/**
* Sets the expression that evaluates to the ID of the send message that
should be canceled.
*
- * @param sendidexpr the expression that evaluates to the ID of the send
message that should be canceled.
+ * @param sendidexpr The expression that evaluates to the ID of the send
message that should be canceled.
*/
public void setSendidexpr(final String sendidexpr) {
this.sendidexpr = sendidexpr;
diff --git
a/src/main/java/org/apache/commons/scxml2/model/ContentContainer.java
b/src/main/java/org/apache/commons/scxml2/model/ContentContainer.java
index b91eed7a..8b3a787c 100644
--- a/src/main/java/org/apache/commons/scxml2/model/ContentContainer.java
+++ b/src/main/java/org/apache/commons/scxml2/model/ContentContainer.java
@@ -33,7 +33,7 @@ public interface ContentContainer {
/**
* Sets the content
*
- * @param content the content to set
+ * @param content The content to set
*/
void setContent(Content content);
}
diff --git
a/src/main/java/org/apache/commons/scxml2/model/CustomActionWrapper.java
b/src/main/java/org/apache/commons/scxml2/model/CustomActionWrapper.java
index 5b4186fd..976564b1 100644
--- a/src/main/java/org/apache/commons/scxml2/model/CustomActionWrapper.java
+++ b/src/main/java/org/apache/commons/scxml2/model/CustomActionWrapper.java
@@ -111,7 +111,7 @@ public class CustomActionWrapper extends Action {
/**
* Sets the attributes defined on the custom action element
*
- * @param attributes the attributes to set
+ * @param attributes The attributes to set
*/
public void setAttributes(final Map<String, String> attributes) {
this.attributes = attributes;
diff --git a/src/main/java/org/apache/commons/scxml2/model/DoneData.java
b/src/main/java/org/apache/commons/scxml2/model/DoneData.java
index 16c4ab05..ba155256 100644
--- a/src/main/java/org/apache/commons/scxml2/model/DoneData.java
+++ b/src/main/java/org/apache/commons/scxml2/model/DoneData.java
@@ -58,7 +58,7 @@ public class DoneData implements ContentContainer,
ParamsContainer, Serializable
/**
* Sets the content
*
- * @param content the content to set
+ * @param content The content to set
*/
@Override
public void setContent(final Content content) {
diff --git a/src/main/java/org/apache/commons/scxml2/model/EnterableState.java
b/src/main/java/org/apache/commons/scxml2/model/EnterableState.java
index be5e297d..7bc682b4 100644
--- a/src/main/java/org/apache/commons/scxml2/model/EnterableState.java
+++ b/src/main/java/org/apache/commons/scxml2/model/EnterableState.java
@@ -106,7 +106,7 @@ public abstract class EnterableState extends
TransitionTarget implements Documen
/**
* Sets the document order of this state
*
- * @param order the document order
+ * @param order The document order
* @see DocumentOrder
*/
public final void setOrder(final int order) {
diff --git a/src/main/java/org/apache/commons/scxml2/model/Invoke.java
b/src/main/java/org/apache/commons/scxml2/model/Invoke.java
index 52bdc9c9..aabc2dcb 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Invoke.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Invoke.java
@@ -367,7 +367,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
/**
* Sets the flag indicating whether to forward events to the invoked
process.
*
- * @param autoForward the flag
+ * @param autoForward The flag
*/
public final void setAutoForward(final Boolean autoForward) {
this.autoForward = autoForward;
@@ -376,7 +376,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
/**
* Sets the content
*
- * @param content the content to set
+ * @param content The content to set
*/
@Override
public void setContent(final Content content) {
@@ -423,7 +423,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
* Sets the parent EnterableState.
*
* @param parent The parent state to set
- * @param invokeIndex the invoke index in the parent (TransitionalState)
defined invokers
+ * @param invokeIndex The invoke index in the parent (TransitionalState)
defined invokers
*/
public void setParentEnterableState(final EnterableState parent, final int
invokeIndex) {
if (parent == null) {
diff --git a/src/main/java/org/apache/commons/scxml2/model/ModelException.java
b/src/main/java/org/apache/commons/scxml2/model/ModelException.java
index 905dc42c..4a3e7125 100644
--- a/src/main/java/org/apache/commons/scxml2/model/ModelException.java
+++ b/src/main/java/org/apache/commons/scxml2/model/ModelException.java
@@ -36,7 +36,7 @@ public class ModelException extends Exception {
/**
* @see Exception#Exception(String)
- * @param message the detail message
+ * @param message The detail message
*/
public ModelException(final String message) {
super(message);
@@ -44,8 +44,8 @@ public class ModelException extends Exception {
/**
* @see Exception#Exception(String, Throwable)
- * @param message the detail message
- * @param cause the cause
+ * @param message The detail message
+ * @param cause The cause
*/
public ModelException(final String message, final Throwable cause) {
super(message, cause);
@@ -53,7 +53,7 @@ public class ModelException extends Exception {
/**
* @see Exception#Exception(Throwable)
- * @param cause the cause
+ * @param cause The cause
*/
public ModelException(final Throwable cause) {
super(cause);
diff --git a/src/main/java/org/apache/commons/scxml2/model/Parallel.java
b/src/main/java/org/apache/commons/scxml2/model/Parallel.java
index af1251cd..0417d53d 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Parallel.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Parallel.java
@@ -40,7 +40,7 @@ public class Parallel extends TransitionalState {
/**
* Add a TransitionalState (State or Parallel) child
*
- * @param ts the child to add
+ * @param ts The child to add
*/
public final void addChild(final TransitionalState ts) {
super.addChild(ts);
diff --git a/src/main/java/org/apache/commons/scxml2/model/PayloadBuilder.java
b/src/main/java/org/apache/commons/scxml2/model/PayloadBuilder.java
index d5a19260..4ed030e3 100644
--- a/src/main/java/org/apache/commons/scxml2/model/PayloadBuilder.java
+++ b/src/main/java/org/apache/commons/scxml2/model/PayloadBuilder.java
@@ -47,12 +47,12 @@ public class PayloadBuilder {
* (typically data ids or for example XPath variables). The names and the
values they 'point' at
* are added to the payload data map.
*
- * @param parentState the enterable state in which the namelist holder is
defined
- * @param ctx the Context to look up the data
- * @param evaluator the evaluator to evaluate/lookup the data
+ * @param parentState The enterable state in which the namelist holder is
defined
+ * @param ctx The Context to look up the data
+ * @param evaluator The evaluator to evaluate/lookup the data
* @param errorReporter to report errors
- * @param namelist the namelist
- * @param payload the payload data map to be updated
+ * @param namelist The namelist
+ * @param payload The payload data map to be updated
* @throws SCXMLExpressionException if a malformed or invalid expression
is evaluated
* @see PayloadBuilder#addToPayload(String, Object, java.util.Map)
*/
@@ -78,9 +78,9 @@ public class PayloadBuilder {
* Adds data to the payload data map based on the {@link Param}s of this
{@link ParamsContainer}
*
* @param ctx The Context to look up the data
- * @param evaluator the evaluator to evaluate/lookup the data
- * @param paramsList the list of params
- * @param payload the payload data map to be updated
+ * @param evaluator The evaluator to evaluate/lookup the data
+ * @param paramsList The list of params
+ * @param payload The payload data map to be updated
* @throws SCXMLExpressionException if a malformed or invalid expression
is evaluated
* @see PayloadBuilder#addToPayload(String, Object, java.util.Map)
*/
@@ -117,9 +117,9 @@ public class PayloadBuilder {
* to the payload data map. This includes 'nested' values within a {@link
NodeList}, {@link List} or {@link Map}.
* </p>
*
- * @param attrName the name of the attribute to add
- * @param attrValue the value of the attribute to add
- * @param payload the payload data map to be updated
+ * @param attrName The name of the attribute to add
+ * @param attrValue The value of the attribute to add
+ * @param payload The payload data map to be updated
*/
@SuppressWarnings("unchecked")
public static void addToPayload(final String attrName, final Object
attrValue, final Map<String, Object> payload) {
diff --git a/src/main/java/org/apache/commons/scxml2/model/Send.java
b/src/main/java/org/apache/commons/scxml2/model/Send.java
index c2cf90aa..d933ba52 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Send.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Send.java
@@ -72,7 +72,7 @@ public class Send extends Action implements ContentContainer,
ParamsContainer {
*
* @param delayString The String value of the delay, in CSS2 format
* @param expression indicates if this is for a delayexpr or delay
attribute
- * @param delayStringSource the original delayString source (delayString
might be different in case of a delayexpr)
+ * @param delayStringSource The original delayString source (delayString
might be different in case of a delayexpr)
* @return The parsed delay in milliseconds
* @throws SCXMLExpressionException If the delay cannot be parsed
*/
@@ -411,7 +411,7 @@ public class Send extends Action implements
ContentContainer, ParamsContainer {
/**
* Sets the content
*
- * @param content the content to set
+ * @param content The content to set
*/
@Override
public void setContent(final Content content) {
diff --git
a/src/main/java/org/apache/commons/scxml2/model/SimpleTransition.java
b/src/main/java/org/apache/commons/scxml2/model/SimpleTransition.java
index a01c38a8..4d86f626 100644
--- a/src/main/java/org/apache/commons/scxml2/model/SimpleTransition.java
+++ b/src/main/java/org/apache/commons/scxml2/model/SimpleTransition.java
@@ -244,7 +244,7 @@ public class SimpleTransition extends Executable implements
Observable {
/**
* Sets the observableId for this Observable, which must be unique within
the SCXML state machine
*
- * @param observableId the observableId
+ * @param observableId The observableId
*/
public final void setObservableId(final Integer observableId) {
this.observableId = observableId;
@@ -265,7 +265,7 @@ public class SimpleTransition extends Executable implements
Observable {
/**
* Sets the Transition type
*
- * @param type the Transition type
+ * @param type The Transition type
*/
public final void setType(final TransitionType type) {
this.type = type;
diff --git a/src/main/java/org/apache/commons/scxml2/model/State.java
b/src/main/java/org/apache/commons/scxml2/model/State.java
index f2351b73..38f4b971 100644
--- a/src/main/java/org/apache/commons/scxml2/model/State.java
+++ b/src/main/java/org/apache/commons/scxml2/model/State.java
@@ -47,7 +47,7 @@ public class State extends TransitionalState {
/**
* Adds an EnterableState (State, Final or Parallel) child
*
- * @param es the child to add
+ * @param es The child to add
*/
@Override
public final void addChild(final EnterableState es) {
diff --git a/src/main/java/org/apache/commons/scxml2/model/Transition.java
b/src/main/java/org/apache/commons/scxml2/model/Transition.java
index cca43972..bbd44d7a 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Transition.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Transition.java
@@ -163,7 +163,7 @@ public class Transition extends SimpleTransition implements
DocumentOrder {
/**
* Sets the document order of this transition
*
- * @param order the document order
+ * @param order The document order
* @see DocumentOrder
*/
public final void setOrder(final int order) {
diff --git
a/src/main/java/org/apache/commons/scxml2/model/TransitionTarget.java
b/src/main/java/org/apache/commons/scxml2/model/TransitionTarget.java
index 5a220285..a1dc793a 100644
--- a/src/main/java/org/apache/commons/scxml2/model/TransitionTarget.java
+++ b/src/main/java/org/apache/commons/scxml2/model/TransitionTarget.java
@@ -66,7 +66,7 @@ public abstract class TransitionTarget implements
Serializable, Observable {
/**
* Gets the ancestor of this TransitionTarget at specified level
*
- * @param level the level of the ancestor to return, zero being top
+ * @param level The level of the ancestor to return, zero being top
* @return The ancestor at specified level
*/
public EnterableState getAncestor(final int level) {
@@ -142,7 +142,7 @@ public abstract class TransitionTarget implements
Serializable, Observable {
/**
* Sets the observableId for this Observable, which must be unique within
the SCXML state machine
*
- * @param observableId the observableId
+ * @param observableId The observableId
*/
public final void setObservableId(final Integer observableId) {
this.observableId = observableId;
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 eb4f0b21..d068fffc 100644
--- a/src/main/java/org/apache/commons/scxml2/model/TransitionalState.java
+++ b/src/main/java/org/apache/commons/scxml2/model/TransitionalState.java
@@ -107,7 +107,7 @@ public abstract class TransitionalState extends
EnterableState {
/**
* Gets the ancestor of this TransitionalState at specified level
*
- * @param level the level of the ancestor to return, zero being top
+ * @param level The level of the ancestor to return, zero being top
* @return The ancestor at specified level
*/
@Override
diff --git
a/src/main/java/org/apache/commons/scxml2/semantics/SCXMLSemanticsImpl.java
b/src/main/java/org/apache/commons/scxml2/semantics/SCXMLSemanticsImpl.java
index 666de25b..2dd05992 100644
--- a/src/main/java/org/apache/commons/scxml2/semantics/SCXMLSemanticsImpl.java
+++ b/src/main/java/org/apache/commons/scxml2/semantics/SCXMLSemanticsImpl.java
@@ -267,8 +267,8 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
/**
* @return true if no member of the provided states set is a descendant of
the provided state.
- * @param states the set of states to check for descendants
- * @param state the state to check with
+ * @param states The set of states to check for descendants
+ * @param state The state to check with
*/
public boolean containsNoDescendant(final Set<EnterableState> states,
final EnterableState state) {
for (final EnterableState es : states) {
@@ -284,8 +284,8 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
* already have been pre-computed in {@link
#microStep(SCXMLExecutionContext, Step, java.util.Set)}.
*
* @param exctx The execution context for this micro step
- * @param step the step
- * @param statesToInvoke the set of activated states which invokes need to
be invoked at the end of the current
+ * @param step The step
+ * @param statesToInvoke The set of activated states which invokes need to
be invoked at the end of the current
* macro step
* @throws ModelException if a SCXML model error occurred during the
execution.
*/
@@ -347,7 +347,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
* Executes the executable content for a specific executable in the micro
step
*
* @param exctx The execution context for this micro step
- * @param exec the executable providing the execution content
+ * @param exec The executable providing the execution content
* @throws ModelException if a SCXML model error occurred during the
execution.
*/
public void executeContent(final SCXMLExecutionContext exctx, final
Executable exec) throws ModelException {
@@ -401,7 +401,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
* Executes the executable content for all transitions in the micro step
*
* @param exctx The execution context for this micro step
- * @param step the step
+ * @param step The step
* @throws ModelException if a SCXML model error occurred during the
execution.
*/
public void executeTransitionContent(final SCXMLExecutionContext exctx,
final Step step) throws ModelException {
@@ -415,8 +415,8 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
* already have been pre-computed in {@link
#microStep(SCXMLExecutionContext, Step, java.util.Set)}.
*
* @param exctx The execution context for this micro step
- * @param step the step
- * @param statesToInvoke the set of activated states which invokes need to
be invoked at the end of the current
+ * @param step The step
+ * @param statesToInvoke The set of activated states which invokes need to
be invoked at the end of the current
* macro step
* @throws ModelException if a SCXML model error occurred during the
execution.
*/
@@ -568,7 +568,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
* Initiate any new invoked activities.
*
* @param exctx provides the execution context
- * @param statesToInvoke the set of activated states which invokes need to
be invoked
+ * @param statesToInvoke The set of activated states which invokes need to
be invoked
* @throws ModelException if there is a fatal SCXML state error
*/
public void initiateInvokes(final SCXMLExecutionContext exctx,
@@ -598,8 +598,8 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
/**
* This method corresponds to the Algorithm for SCXML processing
isFinalState() function.
*
- * @param es the enterable state to check
- * @param configuration the current state machine configuration
+ * @param es The enterable state to check
+ * @param configuration The current state machine configuration
* @return Return true if s is a compound state and one of its children is
an active final state (i.e. is a member
* of the current configuration), or if s is a parallel state and
isInFinalState is true of all its children.
*/
@@ -627,7 +627,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
* configuration (with the respect to the definition of the OR and AND
* states).
*
- * @param states a set of states
+ * @param states A set of states
* @param errRep ErrorReporter to report detailed error info if needed
* @return true if a given state configuration is legal, false otherwise
*/
@@ -691,7 +691,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
* </p>
*
* @param exctx The execution context for this step
- * @param statesToInvoke the set of activated states which invokes need to
be invoked at the end of the current
+ * @param statesToInvoke The set of activated states which invokes need to
be invoked at the end of the current
* macro step
* @throws ModelException if a SCXML model error occurred during the
execution.
*/
@@ -787,7 +787,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics {
*
* @param exctx The execution context for this step
* @param step The current micro step
- * @param statesToInvoke the set of activated states which invokes need to
be invoked at the end of the current
+ * @param statesToInvoke The set of activated states which invokes need to
be invoked at the end of the current
* macro step
* @throws ModelException if a SCXML model error occurred during the
execution.
*/
@@ -1089,7 +1089,7 @@ public class SCXMLSemanticsImpl implements SCXMLSemantics
{
* SCXML specification predefined types.
* </p>
*
- * @param scInstance the state machine instance holding the system context
+ * @param scInstance The state machine instance holding the system context
* @param event The event being stored
* @param internal Flag indicating the event was received internally or
externally
*/
diff --git a/src/main/java/org/apache/commons/scxml2/test/StandaloneUtils.java
b/src/main/java/org/apache/commons/scxml2/test/StandaloneUtils.java
index bc8047c0..86fa8f96 100644
--- a/src/main/java/org/apache/commons/scxml2/test/StandaloneUtils.java
+++ b/src/main/java/org/apache/commons/scxml2/test/StandaloneUtils.java
@@ -135,7 +135,7 @@ public final class StandaloneUtils {
}
/**
- * @param uri an absolute or relative URL
+ * @param uri An absolute or relative URL
* @return {@link String} canonical URL (absolute)
* @throws IOException if a relative URL cannot be resolved
* to a local file
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 447214de..c448e522 100644
--- a/src/test/java/org/apache/commons/scxml2/w3c/W3CTests.java
+++ b/src/test/java/org/apache/commons/scxml2/w3c/W3CTests.java
@@ -515,7 +515,7 @@ public class W3CTests {
/**
* Download and transform a W3C IRP test resource file
*
- * @param specid the SCXML 1.0 spec id (anchor) for the current
assertion, which is used to determine if, how and where the resource should be
+ * @param specid The SCXML 1.0 spec id (anchor) for the current
assertion, which is used to determine if, how and where the resource should be
* transformed.
* @param resource The test resource definition
* @param transformers map of datamodel transformers to produce a
datamodel specific SCXML document from the txml resource
@@ -544,8 +544,8 @@ public class W3CTests {
/**
* Run a single W3C IRP assert test
* @param assertion The W3C IRP assert, defining one or more {@link
Assertions.TestCase}s
- * @param tests the tests configurations
- * @param datamodel the datamodel to limit and restrict the execution of
the test
+ * @param tests The tests configurations
+ * @param datamodel The datamodel to limit and restrict the execution of
the test
* @param status true to run the test with status true for the (or any)
datamodel, false to do so for status false
* @param singleTest if true a single test id was specified which will be
executed even if disabled in the configuration.
* @throws Exception
@@ -589,9 +589,9 @@ public class W3CTests {
/**
* Run a single W3C IRP SCXML test
- * @param testCase the W3C IRP test definition
- * @param test the test configuration
- * @param scxmlFile the file handle for the SCXML document
+ * @param testCase The W3C IRP test definition
+ * @param test The test configuration
+ * @param scxmlFile The file handle for the SCXML document
*/
protected boolean runTest(final Assertions.TestCase testCase, final
Tests.Test test, final File scxmlFile) {
try {
@@ -635,7 +635,7 @@ public class W3CTests {
/**
* Run one or multiple W3C IRP tests
- * @param testId a W3C IRP test id, or null to specify all tests to run
+ * @param testId A W3C IRP test id, or null to specify all tests to run
* @param datamodel only tests available for or executable with the
specified datamodel will be run (or all if null)
* @throws Exception
*/
@@ -682,9 +682,9 @@ public class W3CTests {
/**
* XSL transform a W3C IRP test SCXML resource to a datamodel specific
location and format, or simply copy a non SCXML resource to that location.
*
- * @param resource the test resource definition
- * @param transformer the XSL transformer to use
- * @param targetDir the target location for the transformed SCXML
document, or the non-SCXML resource
+ * @param resource The test resource definition
+ * @param transformer The XSL transformer to use
+ * @param targetDir The target location for the transformed SCXML
document, or the non-SCXML resource
* @throws Exception
*/
protected void transformResource(final Assertions.Resource resource, final
Transformer transformer, final String targetDir) throws Exception {
