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 26e52d16 Javadoc: Use {@code ...}
26e52d16 is described below
commit 26e52d16ea3964ced2b3dbe5525885f8734e0a97
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Wed Jan 17 09:30:19 2024 -0500
Javadoc: Use {@code ...}
---
src/main/java/org/apache/commons/scxml2/PathResolver.java | 2 +-
src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java | 4 ++--
.../java/org/apache/commons/scxml2/env/javascript/JSBindings.java | 4 ++--
.../java/org/apache/commons/scxml2/env/javascript/JSEvaluator.java | 4 ++--
src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java | 2 +-
src/main/java/org/apache/commons/scxml2/io/SCXMLWriter.java | 6 +++---
src/main/java/org/apache/commons/scxml2/model/SCXML.java | 4 ++--
7 files changed, 13 insertions(+), 13 deletions(-)
diff --git a/src/main/java/org/apache/commons/scxml2/PathResolver.java
b/src/main/java/org/apache/commons/scxml2/PathResolver.java
index 3b0aee15..b1fd91e6 100644
--- a/src/main/java/org/apache/commons/scxml2/PathResolver.java
+++ b/src/main/java/org/apache/commons/scxml2/PathResolver.java
@@ -34,7 +34,7 @@ public interface PathResolver {
* Resolve this context sensitive path to an absolute URL.
*
* @param ctxPath Context sensitive path, can be a relative URL
- * @return Resolved path (an absolute URL) or <code>null</code>
+ * @return Resolved path (an absolute URL) or {@code null}
*/
String resolvePath(String ctxPath);
diff --git a/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
b/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
index 9155f6ee..9213c951 100644
--- a/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
+++ b/src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java
@@ -281,7 +281,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
/**
* Gets the {@link Invoker} for this {@link Invoke}.
- * May return <code>null</code>. A non-null {@link Invoker} will be
+ * May return {@code null}. A non-null {@link Invoker} will be
* returned if and only if the {@link Invoke} parent TransitionalState is
* currently active and contains the <invoke> child.
*
@@ -380,7 +380,7 @@ public class SCXMLExecutionContext implements
SCXMLIOProcessor {
* @param type The type of the target being invoked.
* @return An {@link Invoker} for the specified type, if an
* invoker class is registered against that type,
- * <code>null</code> otherwise.
+ * {@code null} otherwise.
* @throws InvokerException When a suitable {@link Invoker} cannot be
instantiated.
*/
public Invoker newInvoker(final String type) throws InvokerException {
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 ff01077e..363f82ee 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
@@ -37,7 +37,7 @@ public class JSBindings implements Bindings {
*
* @param jsContext initial SCXML Context to use for script variables.
*
- * @throws IllegalArgumentException Thrown if <code>jsContext</code> is
<code>null</code>.
+ * @throws IllegalArgumentException Thrown if <code>jsContext</code> is
{@code null}.
*
*/
public JSBindings(final JSContext jsContext) {
@@ -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.
- * @throws IllegalArgumentException Thrown if <code>jsContext</code> is
<code>null</code>.
+ * @throws IllegalArgumentException Thrown if <code>jsContext</code> is
{@code null}.
*/
public void setContext(final JSContext jsContext) {
if (jsContext == null) {
diff --git
a/src/main/java/org/apache/commons/scxml2/env/javascript/JSEvaluator.java
b/src/main/java/org/apache/commons/scxml2/env/javascript/JSEvaluator.java
index 073fceb1..487f2503 100644
--- a/src/main/java/org/apache/commons/scxml2/env/javascript/JSEvaluator.java
+++ b/src/main/java/org/apache/commons/scxml2/env/javascript/JSEvaluator.java
@@ -117,7 +117,7 @@ public class JSEvaluator extends AbstractBaseEvaluator {
* </p>
* @param context SCXML context.
* @param expression Expression to evaluate.
- * @return Result of expression evaluation or <code>null</code>.
+ * @return Result of expression evaluation or {@code null}.
* @throws SCXMLExpressionException Thrown if the expression was invalid
or the execution raised an error itself.
*/
@Override
@@ -164,7 +164,7 @@ public class JSEvaluator extends AbstractBaseEvaluator {
* @param ctx SCXML context.
* @param script Script to execute.
*
- * @return Result of script execution or <code>null</code>.
+ * @return Result of script execution or {@code null}.
*
* @throws SCXMLExpressionException Thrown if the script was invalid.
*/
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 8fc55dd2..d6ac291b 100644
--- a/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java
+++ b/src/main/java/org/apache/commons/scxml2/io/SCXMLReader.java
@@ -253,7 +253,7 @@ public final class SCXMLReader {
}
/**
- * All purpose constructor. Any of the parameters passed in can be
<code>null</code> (booleans should default
+ * All purpose constructor. Any of the parameters passed in can be
{@code null} (booleans should default
* to <code>false</code>).
*
* @param factoryId The <code>factoryId</code> to use.
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 d61d6730..db47eb62 100644
--- a/src/main/java/org/apache/commons/scxml2/io/SCXMLWriter.java
+++ b/src/main/java/org/apache/commons/scxml2/io/SCXMLWriter.java
@@ -202,7 +202,7 @@ public class SCXMLWriter {
}
/**
- * All-purpose constructor. Any of the parameters passed in can be
<code>null</code> (booleans should default
+ * All-purpose constructor. Any of the parameters passed in can be
{@code null} (booleans should default
* to <code>false</code>). At the moment, the <code>factoryId</code>
and <code>factoryClassLoader</code>
* arguments are effectively ignored due to a bug in the underlying
StAX {@link XMLOutputFactory} API.
*
@@ -574,7 +574,7 @@ public class SCXMLWriter {
}
/**
- * Write out this attribute, if the value is not <code>null</code>.
+ * Write out this attribute, if the value is not {@code null}.
*
* @param writer The {@link XMLStreamWriter} in use for the serialization.
* @param localName The local name of the attribute.
@@ -590,7 +590,7 @@ public class SCXMLWriter {
}
/**
- * Write out this attribute, if the value is not <code>null</code>.
+ * Write out this attribute, if the value is not {@code null}.
*
* @param writer The {@link XMLStreamWriter} in use for the serialization.
* @param localName The local name of the attribute.
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 05fbdfbb..cd91b048 100644
--- a/src/main/java/org/apache/commons/scxml2/model/SCXML.java
+++ b/src/main/java/org/apache/commons/scxml2/model/SCXML.java
@@ -249,10 +249,10 @@ public class SCXML implements Serializable, Observable {
/**
* Gets the namespace definitions specified on the SCXML element.
- * May be <code>null</code>.
+ * May be {@code null}.
*
* @return The namespace definitions specified on the SCXML element,
- * may be <code>null</code>.
+ * may be {@code null}.
*/
public final Map<String, String> getNamespaces() {
return namespaces;
