Skip to content

Commit 2da1c6e

Browse files
committed
Use Javadoc instead of HTML tag
1 parent 26fd55b commit 2da1c6e

28 files changed

Lines changed: 87 additions & 87 deletions

src/main/java/org/apache/commons/scxml2/NotificationRegistry.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@
2828

2929
/**
3030
* The registry where SCXML listeners are recorded for nodes of
31-
* interest such as the <code>SCXML</code> root,
32-
* <code>EnterableState</code>s and <code>Transition</code>s.
31+
* interest such as the {@code SCXML} root,
32+
* {@code EnterableState}s and {@code Transition}s.
3333
* The notification registry keeps track of all
34-
* <code>SCXMLListener</code>s attached and notifies relevant
34+
* {@code SCXMLListener}s attached and notifies relevant
3535
* listeners of the events that interest them.
3636
*/
3737
public final class NotificationRegistry {

src/main/java/org/apache/commons/scxml2/SCInstance.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@
3939
import org.apache.commons.scxml2.semantics.ErrorConstants;
4040

4141
/**
42-
* The <code>SCInstance</code> performs book-keeping functions for
42+
* The {@code SCInstance} performs book-keeping functions for
4343
* a particular execution of a state chart represented by a
44-
* <code>SCXML</code> object.
44+
* {@code SCXML} object.
4545
*/
4646
public class SCInstance implements Serializable {
4747

src/main/java/org/apache/commons/scxml2/SCXMLExecutionContext.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -285,7 +285,7 @@ public Map<Invoke, String> getInvokeIds() {
285285
* returned if and only if the {@link Invoke} parent TransitionalState is
286286
* currently active and contains the &lt;invoke&gt; child.
287287
*
288-
* @param invoke The <code>Invoke</code>.
288+
* @param invoke The {@code Invoke}.
289289
* @return The Invoker.
290290
*/
291291
public Invoker getInvoker(final Invoke invoke) {

src/main/java/org/apache/commons/scxml2/SCXMLExecutor.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
* encapsulated in the SCXMLSemantics implementation that it uses.</p>
4040
*
4141
* <p>The default implementation is
42-
* <code>org.apache.commons.scxml2.semantics.SCXMLSemanticsImpl</code></p>
42+
* {@code org.apache.commons.scxml2.semantics.SCXMLSemanticsImpl}</p>
4343
*
4444
* <p>The executor uses SCXMLExecutionContext to manage the state and
4545
* provide all the services to the SCXMLSemantics implementation.</p>

src/main/java/org/apache/commons/scxml2/SCXMLSemantics.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
* <p>The purpose of this interface is to separate the
2828
* <a href="https://www.w3.org/TR/2015/REC-scxml-20150901/#AlgorithmforSCXMLInterpretation">
2929
* W3C SCXML Algorithm for SCXML Interpretation</a>
30-
* from the <code>SCXMLExecutor</code> and therefore make it pluggable.</p>
30+
* from the {@code SCXMLExecutor} and therefore make it pluggable.</p>
3131
* <p>
3232
* From an SCXML execution POV, there are only four entry points needed into the Algorithm, namely:
3333
* </p>
@@ -66,7 +66,7 @@
6666
* </p>
6767
*
6868
* <p>Specific semantics can be created by subclassing
69-
* <code>org.apache.commons.scxml2.semantics.SCXMLSemanticsImpl</code>.</p>
69+
* {@code org.apache.commons.scxml2.semantics.SCXMLSemanticsImpl}.</p>
7070
*/
7171
public interface SCXMLSemantics {
7272

src/main/java/org/apache/commons/scxml2/TriggerEvent.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,32 +32,32 @@ public class TriggerEvent implements Serializable {
3232
private static final long serialVersionUID = 1L;
3333

3434
/**
35-
* <code>CALL_EVENT</code>.
35+
* {@code CALL_EVENT}.
3636
*/
3737
public static final int CALL_EVENT = 1;
3838

3939
/**
40-
* <code>CHANGE_EVENT</code>.
40+
* {@code CHANGE_EVENT}.
4141
*/
4242
public static final int CHANGE_EVENT = 2;
4343

4444
/**
45-
* <code>SIGNAL_EVENT</code>.
45+
* {@code SIGNAL_EVENT}.
4646
*/
4747
public static final int SIGNAL_EVENT = 3;
4848

4949
/**
50-
* <code>TIME_EVENT</code>.
50+
* {@code TIME_EVENT}.
5151
*/
5252
public static final int TIME_EVENT = 4;
5353

5454
/**
55-
* <code>ERROR_EVENT</code>.
55+
* {@code ERROR_EVENT}.
5656
*/
5757
public static final int ERROR_EVENT = 5;
5858

5959
/**
60-
* <code>CANCEL_EVENT</code>.
60+
* {@code CANCEL_EVENT}.
6161
*/
6262
public static final int CANCEL_EVENT = 6;
6363

src/main/java/org/apache/commons/scxml2/env/AbstractSCXMLListener.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
import org.apache.commons.scxml2.model.TransitionTarget;
2323

2424
/**
25-
* An abstract adapter class for the <code>SXCMLListener</code> interface.
25+
* An abstract adapter class for the {@code SXCMLListener} interface.
2626
* This class exists as a convenience for creating listener objects, and as
2727
* such all the methods in this class are empty.
2828
*

src/main/java/org/apache/commons/scxml2/env/AbstractStateMachine.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@
6060
* <p>This class swallows all exceptions only to log them. Developers of
6161
* subclasses should think of themselves as &quot;component developers&quot;
6262
* catering to other end users, and therefore ensure that the subclasses
63-
* are free of <code>ModelException</code>s and the like. Most methods
64-
* are <code>protected</code> for ease of subclassing.</p>
63+
* are free of {@code ModelException}s and the like. Most methods
64+
* are {@code protected} for ease of subclassing.</p>
6565
*/
6666
public abstract class AbstractStateMachine {
6767

src/main/java/org/apache/commons/scxml2/env/SimpleContext.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ public Object get(final String name) {
9494
}
9595

9696
/**
97-
* Gets the log used by this <code>Context</code> instance.
97+
* Gets the log used by this {@code Context} instance.
9898
*
9999
* @return Log The log being used.
100100
*/

src/main/java/org/apache/commons/scxml2/env/SimpleDispatcher.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,16 @@
3333
import org.apache.commons.scxml2.model.ActionExecutionError;
3434

3535
/**
36-
* <p>EventDispatcher implementation that can schedule <code>delay</code>ed
37-
* &lt;send&gt; events for the &quot;scxml&quot; <code>type</code>
36+
* <p>EventDispatcher implementation that can schedule {@code delay}ed
37+
* &lt;send&gt; events for the &quot;scxml&quot; {@code type}
3838
* attribute value (which is also the default). This implementation uses
39-
* J2SE <code>Timer</code>s.</p>
39+
* J2SE {@code Timer}s.</p>
4040
*
41-
* <p>No other <code>type</code>s are processed. Subclasses may support
42-
* additional <code>type</code>s by overriding the
43-
* <code>send(...)</code> and <code>cancel(...)</code> methods and
44-
* delegating to their <code>super</code> counterparts for the
45-
* &quot;scxml&quot; <code>type</code>.</p>
41+
* <p>No other {@code type}s are processed. Subclasses may support
42+
* additional {@code type}s by overriding the
43+
* {@code send(...)} and {@code cancel(...)} methods and
44+
* delegating to their {@code super} counterparts for the
45+
* &quot;scxml&quot; {@code type}.</p>
4646
*/
4747
public class SimpleDispatcher implements EventDispatcher, Serializable {
4848

@@ -100,8 +100,8 @@ public void run() {
100100
private static final Log log = LogFactory.getLog(EventDispatcher.class);
101101

102102
/**
103-
* The <code>Map</code> of active <code>Timer</code>s, keyed by
104-
* &lt;send&gt; element <code>id</code>s.
103+
* The {@code Map} of active {@code Timer}s, keyed by
104+
* &lt;send&gt; element {@code id}s.
105105
*/
106106
private final Map<String, Timer> timers = Collections.synchronizedMap(new HashMap<String, Timer>());
107107

0 commit comments

Comments
 (0)