This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-scxml.git
The following commit(s) were added to refs/heads/master by this push:
new 71e6e71e Javadoc
71e6e71e is described below
commit 71e6e71e7bc359f756c8d992d19201dc6cb60db8
Author: Gary D. Gregory <garydgreg...@gmail.com>
AuthorDate: Sun Apr 27 10:30:54 2025 -0400
Javadoc
---
.../org/apache/commons/scxml2/io/SCXMLReader.java | 72 +++++++++++-----------
1 file changed, 36 insertions(+), 36 deletions(-)
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 cff2ce13..863bb763 100644
--- a/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java
+++ b/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java
@@ -897,7 +897,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <assign> element.
+ * Reads the contents of this <assign> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -960,7 +960,7 @@ public final class SCXMLReader {
}
/**
- * Read the following body contents into a String.
+ * Reads the following body contents into a String.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @return The body content read into a String.
@@ -1018,7 +1018,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <cancel> element.
+ * Reads the contents of this <cancel> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -1051,7 +1051,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <content> element.
+ * Reads the contents of this <content> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -1074,7 +1074,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this custom action.
+ * Reads the contents of this custom action.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -1169,7 +1169,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <data> element.
+ * Reads the contents of this <data> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -1200,7 +1200,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <datamodel> element.
+ * Reads the contents of this <datamodel> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -1245,7 +1245,7 @@ public final class SCXMLReader {
* Private utility functions for reading the SCXML document.
*/
/**
- * Read the SCXML document through the {@link XMLStreamReader}.
+ * Reads the SCXML document through the {@link XMLStreamReader}.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -1284,7 +1284,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <donedata> element.
+ * Reads the contents of this <donedata> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -1331,7 +1331,7 @@ public final class SCXMLReader {
}
/**
- * Read the current element into a DOM {@link Element}.
+ * Reads the current element into a DOM {@link Element}.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @return The parsed content as a DOM {@link Element}.
@@ -1414,7 +1414,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <else> element.
+ * Reads the contents of this <else> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param executable The parent {@link Executable} for this action.
@@ -1431,7 +1431,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <elseif> element.
+ * Reads the contents of this <elseif> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param executable The parent {@link Executable} for this action.
@@ -1449,7 +1449,7 @@ public final class SCXMLReader {
}
/**
- * Read this set of executable content elements.
+ * Reads this set of executable content elements.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -1557,7 +1557,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <final> element.
+ * Reads the contents of this <final> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -1614,7 +1614,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <finalize> element.
+ * Reads the contents of this <finalize> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -1635,7 +1635,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <foreach> element.
+ * Reads the contents of this <foreach> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -1663,7 +1663,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of the initial <script> element.
+ * Reads the contents of the initial <script> element.
* @see <a href="https://www.w3.org/TR/2015/REC-scxml-20150901/#scxml";>
* https://www.w3.org/TR/2015/REC-scxml-20150901/#scxml<a> section
3.2.2
*
@@ -1682,7 +1682,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <history> element.
+ * Reads the contents of this <history> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -1723,7 +1723,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <if> element.
+ * Reads the contents of this <if> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -1767,7 +1767,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <initial> element.
+ * Reads the contents of this <initial> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -1841,7 +1841,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <invoke> element.
+ * Reads the contents of this <invoke> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -1898,7 +1898,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <log> element.
+ * Reads the contents of this <log> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param executable The parent {@link Executable} for this action.
@@ -1921,7 +1921,7 @@ public final class SCXMLReader {
}
/**
- * Read the current active namespace declarations.
+ * 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
@@ -1938,7 +1938,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <onentry> element.
+ * Reads the contents of this <onentry> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -1958,7 +1958,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <onexit> element.
+ * Reads the contents of this <onexit> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -1993,7 +1993,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <parallel> element.
+ * Reads the contents of this <parallel> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -2085,7 +2085,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <param> element.
+ * Reads the contents of this <param> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -2120,7 +2120,7 @@ public final class SCXMLReader {
}
/**
- * Read and parse the body of a {@link ParsedValueContainer} element.
+ * Reads and parse the body of a {@link ParsedValueContainer} element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -2188,7 +2188,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <raise> element.
+ * Reads the contents of this <raise> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -2240,7 +2240,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <script> element.
+ * Reads the contents of this <script> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -2271,7 +2271,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <script> element.
+ * Reads the contents of this <script> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -2293,7 +2293,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <scxml> element.
+ * Reads the contents of this <scxml> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -2370,7 +2370,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <send> element.
+ * Reads the contents of this <send> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -2485,7 +2485,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this simple <transition> element.
+ * Reads the contents of this simple <transition> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -2516,7 +2516,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <state> element.
+ * Reads the contents of this <state> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
@@ -2618,7 +2618,7 @@ public final class SCXMLReader {
}
/**
- * Read the contents of this <transition> element.
+ * Reads the contents of this <transition> element.
*
* @param reader The {@link XMLStreamReader} providing the SCXML document
to parse.
* @param configuration The {@link Configuration} to use while parsing.
