(commons-scxml) branch master updated: Javadoc: Use semantic tag instead of style tag

ggregory Fri, 15 Nov 2024 08:47:27 -0800

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 61d6aadb Javadoc: Use semantic tag instead of style tag 61d6aadb is described below commit 61d6aadb4aa137eb10ecc02a23344023f442df2e Author: Gary Gregory <[email protected]> AuthorDate: Fri Nov 15 11:47:16 2024 -0500 Javadoc: Use semantic tag instead of style tag --- .../commons/scxml2/ExternalSCXMLIOProcessor.java | 2 +- .../org/apache/commons/scxml2/SCXMLExecutor.java | 4 ++-- .../org/apache/commons/scxml2/SCXMLSemantics.java | 4 ++-- .../java/org/apache/commons/scxml2/TriggerEvent.java | 2 +- .../org/apache/commons/scxml2/invoke/Invoker.java | 2 +- .../org/apache/commons/scxml2/io/SCXMLReader.java | 2 +- .../org/apache/commons/scxml2/io/SCXMLWriter.java | 2 +- .../java/org/apache/commons/scxml2/w3c/W3CTests.java | 20 ++++++++++---------- 8 files changed, 19 insertions(+), 19 deletions(-) diff --git a/src/main/java/org/apache/commons/scxml2/ExternalSCXMLIOProcessor.java b/src/main/java/org/apache/commons/scxml2/ExternalSCXMLIOProcessor.java index a68fb552..1d27fd82 100644 --- a/src/main/java/org/apache/commons/scxml2/ExternalSCXMLIOProcessor.java +++ b/src/main/java/org/apache/commons/scxml2/ExternalSCXMLIOProcessor.java @@ -18,7 +18,7 @@ package org.apache.commons.scxml2; /** * The ExternalSCXMLIOProcessor is registered in the _ioprocessors system variable under the - * {@link #DEFAULT_EVENT_PROCESSOR} key and maintains a {@link #getLocation() location} field + * {@link #DEFAULT_EVENT_PROCESSOR} key and maintains a {@link #getLocation() location} field * <pre> * whose value holds an address that external entities can use to communicate with this SCXML session using the SCXML Event I/O Processor.</pre> * @see <a href="https://www.w3.org/TR/scxml/#SCXMLEventProcessor";>SCXML specification C.1.1 _ioprocessors Value</a> diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java b/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java index fbdba683..79cf696a 100644 --- a/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java +++ b/src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java @@ -273,7 +273,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor { /** * Gets the state machine that is being executed. - * NOTE: This is the state machine definition or model used by this + * NOTE: This is the state machine definition or model used by this * executor instance. It may be shared across multiple executor instances * and should not be altered once in use. Also note that * manipulation of instance data for the executor should happen through @@ -485,7 +485,7 @@ public class SCXMLExecutor implements SCXMLIOProcessor { /** * Sets the root context for the state machine execution. - * NOTE: Should only be used before the executor is set in motion. + * NOTE: Should only be used before the executor is set in motion. * * @param rootContext The Context that ties to the host environment. */ diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLSemantics.java b/src/main/java/org/apache/commons/scxml2/SCXMLSemantics.java index 0ee98d67..2f882567 100644 --- a/src/main/java/org/apache/commons/scxml2/SCXMLSemantics.java +++ b/src/main/java/org/apache/commons/scxml2/SCXMLSemantics.java @@ -46,8 +46,8 @@ import org.apache.commons.scxml2.model.SCXML; * </ul> * After a state machine has been terminated you can re-initialize the execution context, and start again. * - * The first two methods represent the interpret entry point specified in the Algorithm for SCXML Interpretation. - * The third and fourth method represent the mainEventLoop and exitInterpreter entry points. + * The first two methods represent the interpret entry point specified in the Algorithm for SCXML Interpretation. + * The third and fourth method represent the mainEventLoop and exitInterpreter entry points. * These have been more practically and logically broken into four different methods so that the blocking wait for * external events can be handled externally. * diff --git a/src/main/java/org/apache/commons/scxml2/TriggerEvent.java b/src/main/java/org/apache/commons/scxml2/TriggerEvent.java index f0ff2c45..881d5527 100644 --- a/src/main/java/org/apache/commons/scxml2/TriggerEvent.java +++ b/src/main/java/org/apache/commons/scxml2/TriggerEvent.java @@ -23,7 +23,7 @@ import java.util.Objects; * A class representing an event. Specific event types have been * defined in reference to SCXML. * - * NOTE: Instances are {@link Serializable} as long as the associated + * NOTE: Instances are {@link Serializable} as long as the associated * data, if any, is {@link Serializable}. */ public class TriggerEvent implements Serializable { 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 43462f44..74dfa419 100644 --- a/src/main/java/org/apache/commons/scxml2/invoke/Invoker.java +++ b/src/main/java/org/apache/commons/scxml2/invoke/Invoker.java @@ -58,7 +58,7 @@ import org.apache.commons.scxml2.TriggerEvent; * <li>Either completion or cancellation.</li> * </ol> * - * Note: The semantics of <invoke> are necessarily + * Note: The semantics of <invoke> are necessarily * asynchronous, tending towards long(er) running interactions with external * processes. Implementations cannot communicate with the parent state * machine executor in a synchronous manner. For synchronous 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 1c2a9469..92ec4d2e 100644 --- a/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java +++ b/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java @@ -111,7 +111,7 @@ import org.xml.sax.SAXException; * * See latest version of the SCXML Working Draft for more details. * - * NOTE: The SCXMLReader assumes that the SCXML document to be + * NOTE: The SCXMLReader assumes that the SCXML document to be * parsed is well-formed and correct. If that assumption does not hold, * any subsequent behavior is undefined. * diff --git a/src/main/java/org/apache/commons/scxml2/io/SCXMLWriter.java b/src/main/java/org/apache/commons/scxml2/io/SCXMLWriter.java index deb618d7..3453c076 100644 --- a/src/main/java/org/apache/commons/scxml2/io/SCXMLWriter.java +++ b/src/main/java/org/apache/commons/scxml2/io/SCXMLWriter.java @@ -89,7 +89,7 @@ import org.w3c.dom.Node; * object heirarchy. Used primarily for testing, debugging and * visual verification. * - * NOTE: This writer makes the following assumptions about the + * NOTE: This writer makes the following assumptions about the * original SCXML document(s) parsed to create the object model: * <ul> * <li>The default document namespace is the SCXML namespace: 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 162f5e87..de4b1d99 100644 --- a/src/test/java/org/apache/commons/scxml2/w3c/W3CTests.java +++ b/src/test/java/org/apache/commons/scxml2/w3c/W3CTests.java @@ -54,24 +54,24 @@ import org.apache.commons.scxml2.model.SCXML; /** * W3C SCXML 1.0 IRP tests: <a href="http://www.w3.org/Voice/2013/scxml-irp/";>http://www.w3.org/Voice/2013/scxml-irp/</a>. * - * The W3CTests class is standalone and can download and transform the IRP tests locally using respectively - * commandline parameter get or make. + * The W3CTests class is standalone and can download and transform the IRP tests locally using respectively + * commandline parameter get or make. * * - * To execute one or multiple IRP tests the commandline parameter run must be specified. + * To execute one or multiple IRP tests the commandline parameter run must be specified. * * - * Optional environment parameter -Ddatamodel=<minimal|ecma|jexl|groovy> can be specified to limit the + * Optional environment parameter -Ddatamodel=<minimal|ecma|jexl|groovy> can be specified to limit the * execution of the tests for and using only the specified datamodel language. * * - * Optional environment parameter -Dtest=<testId> can be specified to only execute a single test, which - * also can be combined with the -Ddatamodel parameter. + * Optional environment parameter -Dtest=<testId> can be specified to only execute a single test, which + * also can be combined with the -Ddatamodel parameter. * * - * The W3CTests also uses a separate <code>tests.xml</code> configuration file, located in the - * <code>src/test/resources/w3c</code> directory, which is manually maintained to enable|disable execution - * of tests (when not using the -Dtest parameter, which will always execute the specified test). + * The W3CTests also uses a separate <code>tests.xml</code> configuration file, located in the + * <code>src/test/resources/w3c</code> directory, which is manually maintained to enable|disable execution + * of tests (when not using the -Dtest parameter, which will always execute the specified test). * Furthermore, in this configuration file the current success or failure status, and even more * meta data per test is maintained. * @@ -279,7 +279,7 @@ public class W3CTests { } /** - * Tests model class used for loading the tests.xml configuration file + * Tests model class used for loading the tests.xml configuration file */ @XmlRootElement(name="tests") @XmlAccessorType(XmlAccessType.FIELD)

Previous message

View by thread

View by date

Next message

Reply via email to