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 b92c730b Javadoc
b92c730b is described below
commit b92c730b89e20f81225590ae47efa8461e0ff32a
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:53:51 2026 -0400
Javadoc
---
.../commons/scxml2/ActionExecutionContext.java | 14 +++++++-------
.../java/org/apache/commons/scxml2/Evaluator.java | 2 +-
.../java/org/apache/commons/scxml2/SCInstance.java | 8 ++++----
.../commons/scxml2/SCInstanceObjectInputStream.java | 2 +-
.../apache/commons/scxml2/SCXMLExecutionContext.java | 20 ++++++++++----------
.../org/apache/commons/scxml2/SCXMLExecutor.java | 14 +++++++-------
.../apache/commons/scxml2/SCXMLSystemContext.java | 2 +-
.../apache/commons/scxml2/StateConfiguration.java | 2 +-
src/main/java/org/apache/commons/scxml2/Status.java | 4 ++--
.../commons/scxml2/env/AbstractStateMachine.java | 4 ++--
.../org/apache/commons/scxml2/env/SimpleContext.java | 2 +-
.../commons/scxml2/env/jexl/JexlEvaluator.java | 2 +-
.../org/apache/commons/scxml2/io/ContentParser.java | 4 ++--
.../org/apache/commons/scxml2/io/ModelUpdater.java | 4 ++--
.../org/apache/commons/scxml2/io/SCXMLReader.java | 2 +-
.../java/org/apache/commons/scxml2/model/Action.java | 2 +-
.../commons/scxml2/model/ActionsContainer.java | 2 +-
.../java/org/apache/commons/scxml2/model/Assign.java | 6 +++---
.../java/org/apache/commons/scxml2/model/Cancel.java | 4 ++--
.../commons/scxml2/model/ContentContainer.java | 2 +-
.../apache/commons/scxml2/model/CustomAction.java | 6 +++---
.../commons/scxml2/model/CustomActionWrapper.java | 8 ++++----
.../org/apache/commons/scxml2/model/Datamodel.java | 2 +-
.../apache/commons/scxml2/model/DocumentOrder.java | 2 +-
.../org/apache/commons/scxml2/model/DoneData.java | 2 +-
.../java/org/apache/commons/scxml2/model/ElseIf.java | 2 +-
.../apache/commons/scxml2/model/EnterableState.java | 6 +++---
.../org/apache/commons/scxml2/model/Executable.java | 4 ++--
.../java/org/apache/commons/scxml2/model/Final.java | 2 +-
.../org/apache/commons/scxml2/model/Finalize.java | 2 +-
.../org/apache/commons/scxml2/model/History.java | 4 ++--
.../java/org/apache/commons/scxml2/model/If.java | 4 ++--
.../org/apache/commons/scxml2/model/Initial.java | 4 ++--
.../java/org/apache/commons/scxml2/model/Invoke.java | 10 +++++-----
.../java/org/apache/commons/scxml2/model/Log.java | 4 ++--
.../org/apache/commons/scxml2/model/Observable.java | 2 +-
.../java/org/apache/commons/scxml2/model/OnExit.java | 2 +-
.../java/org/apache/commons/scxml2/model/Param.java | 2 +-
.../org/apache/commons/scxml2/model/ParsedValue.java | 4 ++--
.../java/org/apache/commons/scxml2/model/Raise.java | 2 +-
.../java/org/apache/commons/scxml2/model/SCXML.java | 10 +++++-----
.../java/org/apache/commons/scxml2/model/Send.java | 6 +++---
.../commons/scxml2/model/SimpleTransition.java | 4 ++--
.../org/apache/commons/scxml2/model/Transition.java | 6 +++---
.../commons/scxml2/model/TransitionTarget.java | 8 ++++----
.../commons/scxml2/model/TransitionalState.java | 8 ++++----
.../org/apache/commons/scxml2/semantics/Step.java | 14 +++++++-------
.../java/org/apache/commons/scxml2/model/Hello.java | 2 +-
48 files changed, 117 insertions(+), 117 deletions(-)
diff --git
a/src/main/java/org/apache/commons/scxml2/ActionExecutionContext.java
b/src/main/java/org/apache/commons/scxml2/ActionExecutionContext.java
index b9d9dbcc..f1e50e38 100644
--- a/src/main/java/org/apache/commons/scxml2/ActionExecutionContext.java
+++ b/src/main/java/org/apache/commons/scxml2/ActionExecutionContext.java
@@ -41,7 +41,7 @@ public class ActionExecutionContext {
}
/**
- * @return the SCXML Execution Logger for the application
+ * @return The SCXML Execution Logger for the application
*/
public Log getAppLog() {
return exctx.getAppLog();
@@ -49,14 +49,14 @@ public class ActionExecutionContext {
/**
* @param state an EnterableState
- * @return the context for an EnterableState
+ * @return The context for an EnterableState
*/
public Context getContext(final EnterableState state) {
return exctx.getScInstance().getContext(state);
}
/**
- * @return the error reporter
+ * @return The error reporter
*/
public ErrorReporter getErrorReporter() {
return exctx.getErrorReporter();
@@ -70,28 +70,28 @@ public class ActionExecutionContext {
}
/**
- * @return the event dispatcher
+ * @return The event dispatcher
*/
public EventDispatcher getEventDispatcher() {
return exctx.getEventDispatcher();
}
/**
- * @return the global context
+ * @return The global context
*/
public Context getGlobalContext() {
return exctx.getScInstance().getGlobalContext();
}
/**
- * @return the I/O Processor for the internal event queue
+ * @return The I/O Processor for the internal event queue
*/
public SCXMLIOProcessor getInternalIOProcessor() {
return exctx;
}
/**
- * @return the state machine
+ * @return The state machine
*/
public SCXML getStateMachine() {
return exctx.getStateMachine();
diff --git a/src/main/java/org/apache/commons/scxml2/Evaluator.java
b/src/main/java/org/apache/commons/scxml2/Evaluator.java
index 97247b5b..05743d42 100644
--- a/src/main/java/org/apache/commons/scxml2/Evaluator.java
+++ b/src/main/java/org/apache/commons/scxml2/Evaluator.java
@@ -42,7 +42,7 @@ public interface Evaluator {
*
* @param ctx variable context
* @param expr expression
- * @return the result of the evaluation
+ * @return The result of the evaluation
* @throws SCXMLExpressionException A malformed expression exception
*/
Object eval(Context ctx, String expr)
diff --git a/src/main/java/org/apache/commons/scxml2/SCInstance.java
b/src/main/java/org/apache/commons/scxml2/SCInstance.java
index c53c19c3..f894534c 100644
--- a/src/main/java/org/apache/commons/scxml2/SCInstance.java
+++ b/src/main/java/org/apache/commons/scxml2/SCInstance.java
@@ -266,7 +266,7 @@ public class SCInstance implements Serializable {
}
/**
- * @return the current status for this instance
+ * @return The current status for this instance
*/
public Status getCurrentStatus() {
return currentStatus;
@@ -280,7 +280,7 @@ public class SCInstance implements Serializable {
}
/**
- * @return the global context, which is the top context <em>within</em>
the state machine.
+ * @return The global context, which is the top context <em>within</em>
the state machine.
*/
public Context getGlobalContext() {
if (globalContext == null) {
@@ -297,7 +297,7 @@ public class SCInstance implements Serializable {
* Gets the last configuration for this history.
*
* @param history The history.
- * @return the lastConfiguration.
+ * @return The lastConfiguration.
*/
public Set<EnterableState> getLastConfiguration(final History history) {
Set<EnterableState> lastConfiguration = histories.get(history);
@@ -320,7 +320,7 @@ public class SCInstance implements Serializable {
}
/**
- * @return the state configuration for this instance
+ * @return The state configuration for this instance
*/
public StateConfiguration getStateConfiguration() {
return stateConfiguration;
diff --git
a/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
b/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
index 44d1257b..2a9c5703 100644
--- a/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
+++ b/src/main/java/org/apache/commons/scxml2/SCInstanceObjectInputStream.java
@@ -90,7 +90,7 @@ public class SCInstanceObjectInputStream extends
ObjectInputStream {
*
* @see
org.apache.commons.scxml2.env.groovy.GroovyContext#readObject(ObjectInputStream)
* @param classResolver custom class resolver
- * @return the old classResolver replaced by the new {@code classResolver}
+ * @return The old classResolver replaced by the new {@code classResolver}
*/
public ClassResolver setClassResolver(final ClassResolver classResolver) {
final ClassResolver old = this.classResolver;
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
b/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
index 55b1d776..03de6975 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
@@ -222,7 +222,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
* {@link #attachInstance(SCInstance)} can be used to re-attach a
previously detached instance
* </p>
*
- * @return the detached instance
+ * @return The detached instance
*/
protected SCInstance detachInstance() {
final SCInstance instance = scInstance;
@@ -235,21 +235,21 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
}
/**
- * @return the restricted execution context for actions
+ * @return The restricted execution context for actions
*/
public ActionExecutionContext getActionExecutionContext() {
return actionExecutionContext;
}
/**
- * @return the SCXML Execution Logger for the application
+ * @return The SCXML Execution Logger for the application
*/
public Log getAppLog() {
return appLog;
}
/**
- * @return the error reporter
+ * @return The error reporter
*/
public ErrorReporter getErrorReporter() {
return errorReporter;
@@ -263,7 +263,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
}
/**
- * @return the event dispatcher
+ * @return The event dispatcher
*/
public EventDispatcher getEventDispatcher() {
return eventdispatcher;
@@ -278,7 +278,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
}
/**
- * @return the map of current active Invokes and their invokeId
+ * @return The map of current active Invokes and their invokeId
*/
public Map<Invoke, String> getInvokeIds() {
return invokeIds;
@@ -298,14 +298,14 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
}
/**
- * @return the notification registry
+ * @return The notification registry
*/
public NotificationRegistry getNotificationRegistry() {
return notificationRegistry;
}
/**
- * @return the SCInstance
+ * @return The SCInstance
*/
public SCInstance getScInstance() {
return scInstance;
@@ -316,7 +316,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
}
/**
- * @return the state machine
+ * @return The state machine
*/
public SCXML getStateMachine() {
return scInstance.getStateMachine();
@@ -402,7 +402,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
}
/**
- * @return the next event from the internal event queue, if available
+ * @return The next event from the internal event queue, if available
*/
public TriggerEvent nextInternalEvent() {
return internalEventQueue.poll();
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
b/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
index 43a45d09..e3321fa8 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java
@@ -172,7 +172,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
* {@link #hasPendingEvents()} to check for possible pending events.
* </p>
*
- * @return the detached instance
+ * @return The detached instance
*/
public SCInstance detachInstance() {
return exctx.detachInstance();
@@ -186,7 +186,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
/**
* Gets the environment specific error reporter.
*
- * @return the errorReporter.
+ * @return The errorReporter.
*/
public ErrorReporter getErrorReporter() {
return exctx.getErrorReporter();
@@ -204,14 +204,14 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
/**
* Gets the event dispatcher.
*
- * @return the eventdispatcher.
+ * @return The eventdispatcher.
*/
public EventDispatcher getEventdispatcher() {
return exctx.getEventDispatcher();
}
/**
- * @return the (optionally) <final><donedata/></final>
produced data after the current statemachine
+ * @return The (optionally) <final><donedata/></final>
produced data after the current statemachine
* completed its execution.
*/
public Object getFinalDoneData() {
@@ -241,14 +241,14 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
}
/**
- * @return the parent SCXMLIOProcessor (if any)
+ * @return The parent SCXMLIOProcessor (if any)
*/
public ParentSCXMLIOProcessor getParentSCXMLIOProcessor() {
return parentSCXMLIOProcessor;
}
/**
- * @return the current number of pending external events to be processed.
+ * @return The current number of pending external events to be processed.
*/
public int getPendingEvents() {
return externalEventQueue.size();
@@ -285,7 +285,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor {
* manipulation of any {@link org.apache.commons.scxml2.model.Datamodel}s
associated with this state
* machine definition.
*
- * @return the stateMachine.
+ * @return The stateMachine.
*/
public SCXML getStateMachine() {
return exctx.getStateMachine();
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
b/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
index 1594e28f..eaa709af 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLSystemContext.java
@@ -95,7 +95,7 @@ public class SCXMLSystemContext implements Context,
Serializable {
}
/**
- * @return the wrapped (modifiable) system context
+ * @return The wrapped (modifiable) system context
*/
Context getContext() {
return systemContext;
diff --git a/src/main/java/org/apache/commons/scxml2/StateConfiguration.java
b/src/main/java/org/apache/commons/scxml2/StateConfiguration.java
index 1b0a99fa..61df7a50 100644
--- a/src/main/java/org/apache/commons/scxml2/StateConfiguration.java
+++ b/src/main/java/org/apache/commons/scxml2/StateConfiguration.java
@@ -94,7 +94,7 @@ public class StateConfiguration implements Serializable {
/**
* Gets the current atomic states (leaf only).
*
- * @return the atomic states - simple (leaf) states only.
+ * @return The atomic states - simple (leaf) states only.
*/
public Set<EnterableState> getStates() {
return atomicStatesSet;
diff --git a/src/main/java/org/apache/commons/scxml2/Status.java
b/src/main/java/org/apache/commons/scxml2/Status.java
index 016a657e..ca8ca9b6 100644
--- a/src/main/java/org/apache/commons/scxml2/Status.java
+++ b/src/main/java/org/apache/commons/scxml2/Status.java
@@ -49,7 +49,7 @@ public class Status implements Serializable {
}
/**
- * @return the single top level final state in which the state machine
terminated, or null otherwise
+ * @return The single top level final state in which the state machine
terminated, or null otherwise
*/
public Final getFinalState() {
if (configuration.getStates().size() == 1) {
@@ -64,7 +64,7 @@ public class Status implements Serializable {
/**
* Gets the atomic states configuration (leaf only).
*
- * @return the atomic states configuration - simple (leaf) states only.
+ * @return The atomic states configuration - simple (leaf) states only.
*/
public Set<EnterableState> getStates() {
return configuration.getStates();
diff --git
a/src/main/java/org/apache/commons/scxml2/env/AbstractStateMachine.java
b/src/main/java/org/apache/commons/scxml2/env/AbstractStateMachine.java
index bae22230..1a77f78b 100644
--- a/src/main/java/org/apache/commons/scxml2/env/AbstractStateMachine.java
+++ b/src/main/java/org/apache/commons/scxml2/env/AbstractStateMachine.java
@@ -222,7 +222,7 @@ public abstract class AbstractStateMachine {
* Gets the SCXML engine driving the "lifecycle" of the
* instances of this class.
*
- * @return the engine.
+ * @return The engine.
*/
public SCXMLExecutor getEngine() {
return engine;
@@ -231,7 +231,7 @@ public abstract class AbstractStateMachine {
/**
* Gets the log for this class.
*
- * @return the log.
+ * @return The log.
*/
public Log getLog() {
return log;
diff --git a/src/main/java/org/apache/commons/scxml2/env/SimpleContext.java
b/src/main/java/org/apache/commons/scxml2/env/SimpleContext.java
index aa4bc345..28e69930 100644
--- a/src/main/java/org/apache/commons/scxml2/env/SimpleContext.java
+++ b/src/main/java/org/apache/commons/scxml2/env/SimpleContext.java
@@ -129,7 +129,7 @@ public class SimpleContext implements Context, Serializable
{
/**
* Gets the Map of all local variables in this Context.
*
- * @return the vars.
+ * @return The vars.
*/
@Override
public Map<String, Object> getVars() {
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 c6ff1658..1e3007a5 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
@@ -188,7 +188,7 @@ public class JexlEvaluator extends AbstractBaseEvaluator {
* <em>NOTE: The internal JexlEngine instance can be null when this is
deserialized.</em>
* </p>
*
- * @return the current JexlEngine
+ * @return The current JexlEngine
*/
private JexlEngine getJexlEngine() {
JexlEngine engine = jexlEngine;
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 b04d9cdb..963c3ede 100644
--- a/src/main/java/org/apache/commons/scxml2/io/ContentParser.java
+++ b/src/main/java/org/apache/commons/scxml2/io/ContentParser.java
@@ -172,7 +172,7 @@ public class ContentParser {
* </ul>
*
* @param content the content to parse
- * @return the parsed content object
+ * @return The parsed content object
* @throws IOException In case of parsing exceptions
*/
public ParsedValue parseContent(final String content) throws IOException {
@@ -204,7 +204,7 @@ public class ContentParser {
* Load a resource (URL) as an UTF-8 encoded content string to be parsed
into a ParsedValue content object through {@link #parseContent(String)}
*
* @param resourceURL Resource URL to load content from
- * @return the parsed content object
+ * @return The parsed content object
* @throws IOException In case of loading or parsing exceptions
*/
public ParsedValue parseResource(final String resourceURL) throws
IOException {
diff --git a/src/main/java/org/apache/commons/scxml2/io/ModelUpdater.java
b/src/main/java/org/apache/commons/scxml2/io/ModelUpdater.java
index 41c1cd30..f83bfa10 100644
--- a/src/main/java/org/apache/commons/scxml2/io/ModelUpdater.java
+++ b/src/main/java/org/apache/commons/scxml2/io/ModelUpdater.java
@@ -147,7 +147,7 @@ final class ModelUpdater {
*
* @param states The list of children states of a parent TransitionalState
or the SCXML document itself
* @param nextOrder The next to be used order value
- * @return the next to be used order value
+ * @return The next to be used order value
*/
private static int initDocumentOrder(final List<EnterableState> states,
int nextOrder) {
for (final EnterableState state : states) {
@@ -169,7 +169,7 @@ final class ModelUpdater {
*
* @param states The list of children states of a parent TransitionalState
or the SCXML document itself
* @param nextObservableId The next observable id sequence value to be used
- * @return the next to be used observable id sequence value
+ * @return The next to be used observable id sequence value
*/
private static int initObservables(final List<EnterableState>states, int
nextObservableId) {
for (final EnterableState es : states) {
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 54edc65f..1c9adadd 100644
--- a/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java
+++ b/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java
@@ -1922,7 +1922,7 @@ public final class SCXMLReader {
* Reads the current active namespace declarations.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
- * @return the map of active namespace declarations, null if none defined
+ * @return The map of active namespace declarations, null if none defined
*/
private static Map<String, String> readNamespaces(final XMLStreamReader
reader) {
Map<String, String> namespaces = null;
diff --git a/src/main/java/org/apache/commons/scxml2/model/Action.java
b/src/main/java/org/apache/commons/scxml2/model/Action.java
index 9921de7a..0430a5b3 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Action.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Action.java
@@ -55,7 +55,7 @@ public abstract class Action implements Serializable {
/**
* Gets the Executable parent.
*
- * @return the parent.
+ * @return The parent.
*/
public Executable getParent() {
return parent;
diff --git
a/src/main/java/org/apache/commons/scxml2/model/ActionsContainer.java
b/src/main/java/org/apache/commons/scxml2/model/ActionsContainer.java
index 23a93dab..242dca3d 100644
--- a/src/main/java/org/apache/commons/scxml2/model/ActionsContainer.java
+++ b/src/main/java/org/apache/commons/scxml2/model/ActionsContainer.java
@@ -34,7 +34,7 @@ public interface ActionsContainer {
/**
* Gets the executable actions contained in this <container>.
*
- * @return the actions.
+ * @return The actions.
*/
List<Action> getActions();
}
diff --git a/src/main/java/org/apache/commons/scxml2/model/Assign.java
b/src/main/java/org/apache/commons/scxml2/model/Assign.java
index 300ea2cd..fc9413d8 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Assign.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Assign.java
@@ -90,7 +90,7 @@ public class Assign extends Action implements
ParsedValueContainer {
/**
* Gets the expr that will evaluate to the new value.
*
- * @return the expr.
+ * @return The expr.
*/
public String getExpr() {
return expr;
@@ -99,7 +99,7 @@ public class Assign extends Action implements
ParsedValueContainer {
/**
* Gets the location for a previously defined XML data tree.
*
- * @return the location.
+ * @return The location.
*/
public String getLocation() {
return location;
@@ -118,7 +118,7 @@ public class Assign extends Action implements
ParsedValueContainer {
/**
* Gets the source where the new XML instance for this location exists.
*
- * @return the source.
+ * @return The source.
*/
public String getSrc() {
return src;
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 33e94ab9..04f6abdf 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Cancel.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Cancel.java
@@ -73,7 +73,7 @@ public class Cancel extends Action {
/**
* Gets the ID of the send message that should be canceled.
*
- * @return the sendid.
+ * @return The sendid.
*/
public String getSendid() {
return sendid;
@@ -82,7 +82,7 @@ public class Cancel extends Action {
/**
* Gets the expression that evaluates to the ID of the send message that
should be canceled.
*
- * @return the expression that evaluates to the ID of the send message
that should be canceled.
+ * @return The expression that evaluates to the ID of the send message
that should be canceled.
*/
public String getSendidexpr() {
return 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 f9865bd7..b91eed7a 100644
--- a/src/main/java/org/apache/commons/scxml2/model/ContentContainer.java
+++ b/src/main/java/org/apache/commons/scxml2/model/ContentContainer.java
@@ -26,7 +26,7 @@ public interface ContentContainer {
/**
* Returns the content
*
- * @return the content
+ * @return The content
*/
Content getContent();
diff --git a/src/main/java/org/apache/commons/scxml2/model/CustomAction.java
b/src/main/java/org/apache/commons/scxml2/model/CustomAction.java
index a8cae31f..51a69fa3 100644
--- a/src/main/java/org/apache/commons/scxml2/model/CustomAction.java
+++ b/src/main/java/org/apache/commons/scxml2/model/CustomAction.java
@@ -113,7 +113,7 @@ public class CustomAction {
/**
* Gets this custom action's implementation.
*
- * @return the action class.
+ * @return The action class.
*/
public Class<? extends Action> getActionClass() {
return actionClass;
@@ -122,7 +122,7 @@ public class CustomAction {
/**
* Gets the local name for this custom action.
*
- * @return the local name.
+ * @return The local name.
*/
public String getLocalName() {
return localName;
@@ -131,7 +131,7 @@ public class CustomAction {
/**
* Gets the namespace URI for this custom action.
*
- * @return the namespace URI.
+ * @return The namespace URI.
*/
public String getNamespaceURI() {
return namespaceURI;
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 14e8ba3a..5b4186fd 100644
--- a/src/main/java/org/apache/commons/scxml2/model/CustomActionWrapper.java
+++ b/src/main/java/org/apache/commons/scxml2/model/CustomActionWrapper.java
@@ -65,14 +65,14 @@ public class CustomActionWrapper extends Action {
/**
* Gets the attributes defined on the custom action element
*
- * @return the map of attributes.
+ * @return The map of attributes.
*/
public final Map<String, String> getAttributes() {
return attributes;
}
/**
- * @return the custom action XML element local name
+ * @return The custom action XML element local name
*/
public String getLocalName() {
return localName;
@@ -81,7 +81,7 @@ public class CustomActionWrapper extends Action {
/**
* Gets the custom XML namespaces in effect for this custom action
*
- * @return the map of namespaces.
+ * @return The map of namespaces.
*/
public final Map<String, String> getNamespaces() {
return namespaces;
@@ -98,7 +98,7 @@ public class CustomActionWrapper extends Action {
}
/**
- * @return the custom action element prefix (might be null)
+ * @return The custom action element prefix (might be null)
*/
public String getPrefix() {
return prefix;
diff --git a/src/main/java/org/apache/commons/scxml2/model/Datamodel.java
b/src/main/java/org/apache/commons/scxml2/model/Datamodel.java
index 45c028ff..f4568db9 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Datamodel.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Datamodel.java
@@ -58,7 +58,7 @@ public class Datamodel implements Serializable {
/**
* Gets all the data children of this datamodel.
*
- * @return the data.
+ * @return The data.
*/
public final List<Data> getData() {
return data;
diff --git a/src/main/java/org/apache/commons/scxml2/model/DocumentOrder.java
b/src/main/java/org/apache/commons/scxml2/model/DocumentOrder.java
index f01aac2d..7ad9ac36 100644
--- a/src/main/java/org/apache/commons/scxml2/model/DocumentOrder.java
+++ b/src/main/java/org/apache/commons/scxml2/model/DocumentOrder.java
@@ -34,7 +34,7 @@ public interface DocumentOrder {
Comparator<DocumentOrder> reverseDocumentOrderComparator = (o1, o2) ->
o2.getOrder() - o1.getOrder();
/**
- * @return the relative document order within the SCXML document of this
element
+ * @return The relative document order within the SCXML document of this
element
*/
int getOrder();
}
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 5d4f4450..16c4ab05 100644
--- a/src/main/java/org/apache/commons/scxml2/model/DoneData.java
+++ b/src/main/java/org/apache/commons/scxml2/model/DoneData.java
@@ -38,7 +38,7 @@ public class DoneData implements ContentContainer,
ParamsContainer, Serializable
/**
* Returns the content
*
- * @return the content
+ * @return The content
*/
@Override
public Content getContent() {
diff --git a/src/main/java/org/apache/commons/scxml2/model/ElseIf.java
b/src/main/java/org/apache/commons/scxml2/model/ElseIf.java
index 05b139ba..5714ee05 100644
--- a/src/main/java/org/apache/commons/scxml2/model/ElseIf.java
+++ b/src/main/java/org/apache/commons/scxml2/model/ElseIf.java
@@ -52,7 +52,7 @@ public class ElseIf extends Action {
/**
* Gets the conditional expression.
*
- * @return the cond.
+ * @return The cond.
*/
public final String getCond() {
return cond;
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 37d3cdcb..be5e297d 100644
--- a/src/main/java/org/apache/commons/scxml2/model/EnterableState.java
+++ b/src/main/java/org/apache/commons/scxml2/model/EnterableState.java
@@ -69,7 +69,7 @@ public abstract class EnterableState extends TransitionTarget
implements Documen
/**
* Gets the OnEntry elements.
*
- * @return the onEntry elements
+ * @return The onEntry elements
*/
public final List<OnEntry> getOnEntries() {
return onEntries;
@@ -78,14 +78,14 @@ public abstract class EnterableState extends
TransitionTarget implements Documen
/**
* Gets the OnExit elements
*
- * @return the onExit elements
+ * @return The onExit elements
*/
public final List<OnExit> getOnExits() {
return onExits;
}
/**
- * @return the document order of this state
+ * @return The document order of this state
* @see DocumentOrder
*/
@Override
diff --git a/src/main/java/org/apache/commons/scxml2/model/Executable.java
b/src/main/java/org/apache/commons/scxml2/model/Executable.java
index 0c394ea0..f0c89373 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Executable.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Executable.java
@@ -59,7 +59,7 @@ public abstract class Executable implements Serializable {
/**
* Gets the executable actions contained in this Executable.
*
- * @return the actions.
+ * @return The actions.
*/
public final List<Action> getActions() {
return actions;
@@ -68,7 +68,7 @@ public abstract class Executable implements Serializable {
/**
* Gets the EnterableState parent.
*
- * @return the parent.
+ * @return The parent.
*/
public EnterableState getParent() {
return parent;
diff --git a/src/main/java/org/apache/commons/scxml2/model/Final.java
b/src/main/java/org/apache/commons/scxml2/model/Final.java
index a5d02d13..507a484d 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Final.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Final.java
@@ -53,7 +53,7 @@ public class Final extends EnterableState {
}
/**
- * @return the State parent
+ * @return The State parent
*/
@Override
public State getParent() {
diff --git a/src/main/java/org/apache/commons/scxml2/model/Finalize.java
b/src/main/java/org/apache/commons/scxml2/model/Finalize.java
index 940b9db1..3effbeb1 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Finalize.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Finalize.java
@@ -34,7 +34,7 @@ public class Finalize extends Executable {
}
/**
- * @return the TransitionalState parent
+ * @return The TransitionalState parent
*/
@Override
public TransitionalState getParent() {
diff --git a/src/main/java/org/apache/commons/scxml2/model/History.java
b/src/main/java/org/apache/commons/scxml2/model/History.java
index 7af17351..e66ee99f 100644
--- a/src/main/java/org/apache/commons/scxml2/model/History.java
+++ b/src/main/java/org/apache/commons/scxml2/model/History.java
@@ -46,7 +46,7 @@ public class History extends TransitionTarget {
}
/**
- * @return the TransitionalState parent
+ * @return The TransitionalState parent
*/
@Override
public TransitionalState getParent() {
@@ -56,7 +56,7 @@ public class History extends TransitionTarget {
/**
* Gets the transition.
*
- * @return the transition.
+ * @return The transition.
*/
public final SimpleTransition getTransition() {
return transition;
diff --git a/src/main/java/org/apache/commons/scxml2/model/If.java
b/src/main/java/org/apache/commons/scxml2/model/If.java
index 21076e47..68c9ddd8 100644
--- a/src/main/java/org/apache/commons/scxml2/model/If.java
+++ b/src/main/java/org/apache/commons/scxml2/model/If.java
@@ -121,7 +121,7 @@ public class If extends Action implements ActionsContainer {
/**
* Gets the executable actions contained in this <if>.
*
- * @return the actions.
+ * @return The actions.
*/
@Override
public final List<Action> getActions() {
@@ -131,7 +131,7 @@ public class If extends Action implements ActionsContainer {
/**
* Gets the conditional expression.
*
- * @return the cond.
+ * @return The cond.
*/
public final String getCond() {
return cond;
diff --git a/src/main/java/org/apache/commons/scxml2/model/Initial.java
b/src/main/java/org/apache/commons/scxml2/model/Initial.java
index d8da29b5..cd8f0905 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Initial.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Initial.java
@@ -55,7 +55,7 @@ public class Initial implements Serializable {
/**
* Gets the parent State.
*
- * @return the parent state
+ * @return The parent state
*/
public final State getParent() {
return parent;
@@ -64,7 +64,7 @@ public class Initial implements Serializable {
/**
* Gets the initial transition.
*
- * @return the transition.
+ * @return The transition.
*/
public final SimpleTransition getTransition() {
return transition;
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 d17b6734..52bdc9c9 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Invoke.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Invoke.java
@@ -235,7 +235,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
}
/**
- * @return the flag indicating whether to forward events to the invoked
process.
+ * @return The flag indicating whether to forward events to the invoked
process.
*/
public final Boolean getAutoForward() {
return autoForward;
@@ -244,7 +244,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
/**
* Returns the content
*
- * @return the content
+ * @return The content
*/
@Override
public Content getContent() {
@@ -270,14 +270,14 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
/**
* Gets the identifier for this invoke (may be null).
*
- * @return the id.
+ * @return The id.
*/
public final String getId() {
return id;
}
/**
- * @return the idlocation
+ * @return The idlocation
*/
public String getIdlocation() {
return idlocation;
@@ -305,7 +305,7 @@ public class Invoke extends Action implements
ContentContainer, ParamsContainer
/**
* Gets the parent EnterableState.
*
- * @return the parent state
+ * @return The parent state
*/
@Override
public EnterableState getParentEnterableState() {
diff --git a/src/main/java/org/apache/commons/scxml2/model/Log.java
b/src/main/java/org/apache/commons/scxml2/model/Log.java
index 61f08267..36238ab0 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Log.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Log.java
@@ -62,7 +62,7 @@ public class Log extends Action {
/**
* Gets the log expression.
*
- * @return the expression.
+ * @return The expression.
*/
public final String getExpr() {
return expr;
@@ -71,7 +71,7 @@ public class Log extends Action {
/**
* Gets the log label.
*
- * @return the label.
+ * @return The label.
*/
public final String getLabel() {
return label;
diff --git a/src/main/java/org/apache/commons/scxml2/model/Observable.java
b/src/main/java/org/apache/commons/scxml2/model/Observable.java
index 8fb67c28..4e8dda03 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Observable.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Observable.java
@@ -27,7 +27,7 @@ package org.apache.commons.scxml2.model;
public interface Observable {
/**
- * @return the id for this Observable which is unique within the SCXML
state machine
+ * @return The id for this Observable which is unique within the SCXML
state machine
*/
Integer getObservableId();
}
diff --git a/src/main/java/org/apache/commons/scxml2/model/OnExit.java
b/src/main/java/org/apache/commons/scxml2/model/OnExit.java
index 8320af89..f90dbdc0 100644
--- a/src/main/java/org/apache/commons/scxml2/model/OnExit.java
+++ b/src/main/java/org/apache/commons/scxml2/model/OnExit.java
@@ -41,7 +41,7 @@ public class OnExit extends Executable {
}
/**
- * @return the indicator whether to raise the non-standard "exit.state.id"
internal event after executing
+ * @return The indicator whether to raise the non-standard "exit.state.id"
internal event after executing
* this OnExit. When null no event will be raised
*/
public final Boolean getRaiseEvent() {
diff --git a/src/main/java/org/apache/commons/scxml2/model/Param.java
b/src/main/java/org/apache/commons/scxml2/model/Param.java
index de48da8d..06f02287 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Param.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Param.java
@@ -65,7 +65,7 @@ public class Param implements Serializable {
/**
* Gets the location for a previously defined XML data tree.
*
- * @return the location.
+ * @return The location.
*/
public String getLocation() {
return location;
diff --git a/src/main/java/org/apache/commons/scxml2/model/ParsedValue.java
b/src/main/java/org/apache/commons/scxml2/model/ParsedValue.java
index 62eaf48b..a83706f4 100644
--- a/src/main/java/org/apache/commons/scxml2/model/ParsedValue.java
+++ b/src/main/java/org/apache/commons/scxml2/model/ParsedValue.java
@@ -47,12 +47,12 @@ public interface ParsedValue extends Serializable {
}
/**
- * @return the parsed value type
+ * @return The parsed value type
*/
ValueType getType();
/**
- * @return the parsed value
+ * @return The parsed value
*/
Object getValue();
}
diff --git a/src/main/java/org/apache/commons/scxml2/model/Raise.java
b/src/main/java/org/apache/commons/scxml2/model/Raise.java
index d077112b..0521b236 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Raise.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Raise.java
@@ -62,7 +62,7 @@ public class Raise extends Action {
/**
* Gets the event.
*
- * @return the event.
+ * @return The event.
*/
public final String getEvent() {
return event;
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 23163489..bff73457 100644
--- a/src/main/java/org/apache/commons/scxml2/model/SCXML.java
+++ b/src/main/java/org/apache/commons/scxml2/model/SCXML.java
@@ -176,7 +176,7 @@ public class SCXML implements Serializable, Observable {
/**
* Gets the data model placed at document root.
*
- * @return the data model.
+ * @return The data model.
*/
public final Datamodel getDatamodel() {
return datamodel;
@@ -203,7 +203,7 @@ public class SCXML implements Serializable, Observable {
/**
* Gets the first immediate child of the SCXML root. Return null if
there's no child.
*
- * @return the first immediate child of the SCXML root. Return null if
there's no child.
+ * @return The first immediate child of the SCXML root. Return null if
there's no child.
* @since 2.0
*/
public final EnterableState getFirstChild() {
@@ -230,7 +230,7 @@ public class SCXML implements Serializable, Observable {
/**
* Gets the initial Transition.
*
- * @return the initial transition for this state machine.
+ * @return The initial transition for this state machine.
* @since 2.0
*/
public final SimpleTransition getInitialTransition() {
@@ -268,7 +268,7 @@ public class SCXML implements Serializable, Observable {
/**
* Gets the {@link PathResolver}.
*
- * @return the pathResolver.
+ * @return The pathResolver.
*/
public PathResolver getPathResolver() {
return pathResolver;
@@ -296,7 +296,7 @@ public class SCXML implements Serializable, Observable {
/**
* Gets the SCXML document version.
*
- * @return the version.
+ * @return The version.
*/
public final String getVersion() {
return version;
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 2c5675b0..c2cf90aa 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Send.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Send.java
@@ -293,7 +293,7 @@ public class Send extends Action implements
ContentContainer, ParamsContainer {
/**
* Returns the content
*
- * @return the content
+ * @return The content
*/
@Override
public Content getContent() {
@@ -303,7 +303,7 @@ public class Send extends Action implements
ContentContainer, ParamsContainer {
/**
* Gets the delay.
*
- * @return the delay.
+ * @return The delay.
*/
public final String getDelay() {
return delay;
@@ -351,7 +351,7 @@ public class Send extends Action implements
ContentContainer, ParamsContainer {
}
/**
- * @return the idlocation
+ * @return The idlocation
*/
public String getIdlocation() {
return idlocation;
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 ed731ff7..a01c38a8 100644
--- a/src/main/java/org/apache/commons/scxml2/model/SimpleTransition.java
+++ b/src/main/java/org/apache/commons/scxml2/model/SimpleTransition.java
@@ -104,7 +104,7 @@ public class SimpleTransition extends Executable implements
Observable {
/**
* Gets the TransitionalState (State or Parallel) parent.
*
- * @return the parent.
+ * @return The parent.
*/
@Override
public TransitionalState getParent() {
@@ -114,7 +114,7 @@ public class SimpleTransition extends Executable implements
Observable {
/**
* Gets the set of transition targets (may be an empty list).
*
- * @return the target(s) as specified in SCXML markup.
+ * @return The target(s) as specified in SCXML markup.
* <p>Remarks: Is {@code empty} for "stay" transitions.
*
* @since 0.7
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 5c490d5c..cca43972 100644
--- a/src/main/java/org/apache/commons/scxml2/model/Transition.java
+++ b/src/main/java/org/apache/commons/scxml2/model/Transition.java
@@ -68,7 +68,7 @@ public class Transition extends SimpleTransition implements
DocumentOrder {
/**
* Gets the guard condition (may be null).
*
- * @return the cond.
+ * @return The cond.
*/
public String getCond() {
return cond;
@@ -78,7 +78,7 @@ public class Transition extends SimpleTransition implements
DocumentOrder {
* Gets the event that will trigger this transition (pending
* evaluation of the guard condition in favor).
*
- * @return the event.
+ * @return The event.
*/
public String getEvent() {
return event;
@@ -92,7 +92,7 @@ public class Transition extends SimpleTransition implements
DocumentOrder {
}
/**
- * @return the document order of this transition
+ * @return The document order of this transition
* @see DocumentOrder
*/
@Override
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 57330a4a..5a220285 100644
--- a/src/main/java/org/apache/commons/scxml2/model/TransitionTarget.java
+++ b/src/main/java/org/apache/commons/scxml2/model/TransitionTarget.java
@@ -67,7 +67,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
- * @return the ancestor at specified level
+ * @return The ancestor at specified level
*/
public EnterableState getAncestor(final int level) {
return ancestors[level];
@@ -76,14 +76,14 @@ public abstract class TransitionTarget implements
Serializable, Observable {
/**
* Gets the identifier for this transition target (may be null).
*
- * @return the id.
+ * @return The id.
*/
public final String getId() {
return id;
}
/**
- * @return the number of TransitionTarget ancestors
+ * @return The number of TransitionTarget ancestors
*/
public int getNumberOfAncestors() {
return ancestors.length;
@@ -100,7 +100,7 @@ public abstract class TransitionTarget implements
Serializable, Observable {
/**
* Gets the parent TransitionTarget.
*
- * @return the parent state
+ * @return The parent state
* (null if parent is <scxml> element)
*/
public EnterableState getParent() {
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 9eaf738b..3781fbac 100644
--- a/src/main/java/org/apache/commons/scxml2/model/TransitionalState.java
+++ b/src/main/java/org/apache/commons/scxml2/model/TransitionalState.java
@@ -108,7 +108,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
- * @return the ancestor at specified level
+ * @return The ancestor at specified level
*/
@Override
public TransitionalState getAncestor(final int level) {
@@ -118,7 +118,7 @@ public abstract class TransitionalState extends
EnterableState {
/**
* Gets the set of child transition targets (may be empty).
*
- * @return the children.
+ * @return The children.
* @since 0.7
*/
public final List<EnterableState> getChildren() {
@@ -128,7 +128,7 @@ public abstract class TransitionalState extends
EnterableState {
/**
* Gets the data model for this transition target.
*
- * @return the data model.
+ * @return The data model.
*/
public final Datamodel getDatamodel() {
return datamodel;
@@ -158,7 +158,7 @@ public abstract class TransitionalState extends
EnterableState {
/**
* Gets the TransitionalState (State or Parallel) parent.
*
- * @return the parent.
+ * @return The parent.
*/
@Override
public TransitionalState getParent() {
diff --git a/src/main/java/org/apache/commons/scxml2/semantics/Step.java
b/src/main/java/org/apache/commons/scxml2/semantics/Step.java
index d56730c9..0ab2237e 100644
--- a/src/main/java/org/apache/commons/scxml2/semantics/Step.java
+++ b/src/main/java/org/apache/commons/scxml2/semantics/Step.java
@@ -94,49 +94,49 @@ public class Step {
}
/**
- * @return the defaultEntrySet.
+ * @return The defaultEntrySet.
*/
public Set<EnterableState> getDefaultEntrySet() {
return defaultEntrySet;
}
/**
- * @return the map of default History transitions to be executed as result
of entering states in this step
+ * @return The map of default History transitions to be executed as result
of entering states in this step
*/
public Map<TransitionalState, SimpleTransition>
getDefaultHistoryTransitions() {
return defaultHistoryTransitions;
}
/**
- * @return the entrySet.
+ * @return The entrySet.
*/
public Set<EnterableState> getEntrySet() {
return entrySet;
}
/**
- * @return the current event.
+ * @return The current event.
*/
public TriggerEvent getEvent() {
return event;
}
/**
- * @return the exitSet.
+ * @return The exitSet.
*/
public Set<EnterableState> getExitSet() {
return exitSet;
}
/**
- * @return the map of new History configurations created as result of
exiting states in this step
+ * @return The map of new History configurations created as result of
exiting states in this step
*/
public Map<History, Set<EnterableState>> getNewHistoryConfigurations() {
return newHistoryConfigurations;
}
/**
- * @return the transitList.
+ * @return The transitList.
*/
public List<SimpleTransition> getTransitList() {
return transitList;
diff --git a/src/test/java/org/apache/commons/scxml2/model/Hello.java
b/src/test/java/org/apache/commons/scxml2/model/Hello.java
index 73982a61..19c0d6d3 100644
--- a/src/test/java/org/apache/commons/scxml2/model/Hello.java
+++ b/src/test/java/org/apache/commons/scxml2/model/Hello.java
@@ -49,7 +49,7 @@ public class Hello extends Action {
/**
* Gets the name.
*
- * @return the name.
+ * @return The name.
*/
public String getName() {
return name;
