Skip to content

Commit 86abfc0

Browse files
committed
Fix more javadoc errors
1 parent da1841d commit 86abfc0

File tree

3 files changed

+3
-13
lines changed

3 files changed

+3
-13
lines changed

src/main/java/org/scijava/event/bushe/EventService.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,7 @@ interface EventService {
139139
* <p>
140140
* Due to generic type erasure, the type must be supplied by the caller. You can get a declared object's
141141
* type by using the {@link org.scijava.event.bushe.TypeReference} class. For Example:
142+
* </p>
142143
* <pre>
143144
* TypeReference&#60;List&#60;Trade&#62;&#62; subscribingTypeReference = new TypeReference&#60;List&#60;Trade&#62;&#62;(){};
144145
* EventBus.subscribe(subscribingTypeReference.getType(), mySubscriber);
@@ -151,7 +152,6 @@ interface EventService {
151152
* trades.add(trade);
152153
* EventBus.publish(publishingTypeReference.getType(), trades);
153154
* </pre>
154-
* </p>
155155
* @param genericType the generified type of the published object.
156156
* @param event The event that occurred
157157
*/
@@ -169,7 +169,6 @@ interface EventService {
169169
/**
170170
* Subscribes an EventSubscriber to the publication of objects matching a type. Only a <b>WeakReference</b> to
171171
* the subscriber is held by the EventService.
172-
* </p>
173172
* <p>
174173
* Subscribing to a class means the subscriber will be called when objects of that class are published, when
175174
* objects of subclasses of the class are published, when objects implementing any of the interfaces of the
@@ -202,6 +201,7 @@ interface EventService {
202201
* <p>
203202
* Due to generic type erasure, the type must be supplied by the publisher. You can get a declared object's
204203
* type by using the {@link org.scijava.event.bushe.TypeReference} class. For Example:
204+
* </p>
205205
* <pre>
206206
* TypeReference&#60;List&#60;Trade&#62;&#62; subscribingTypeReference = new TypeReference&#60;List&#60;Trade&#62;&#62;(){};
207207
* EventBus.subscribe(subscribingTypeReference.getType(), mySubscriber);
@@ -214,7 +214,6 @@ interface EventService {
214214
* trades.add(trade);
215215
* EventBus.publish(publishingTypeReference.getType(), trades);
216216
* </pre>
217-
* </p>
218217
* @param type the generic type to subscribe to
219218
* @param subscriber the subscriber to the type
220219
* @return true if a new subscription is made, false if it already existed

src/main/java/org/scijava/event/bushe/SwingException.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,6 @@
3838
* </p>
3939
*
4040
* @author Michael Bushe michael@bushe.com
41-
* @todo in SwingUtils, make an invokeLater() method that saves the calling stack and catches all exceptions from a
42-
* subsequent call to SwingUtilities.invokeLater(), then throws a Swing Exception so the calling stack is saved.
4341
*/
4442
class SwingException extends Exception {
4543
protected StackTraceElement[] callingStackTrace;

src/main/java/org/scijava/event/bushe/ThreadSafeEventService.java

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -65,12 +65,6 @@
6565
* never know if your subscriber has handled an event while it was being subscribed (before the subscribe() method
6666
* returned) that is newer or older than the retrieved cached value (taken before or after subscribe() respectively).
6767
* </p>
68-
* <p>
69-
* To deal with subscribers that take too long (a concern in Swing applications), the EventService can be made to issue
70-
* {@link SubscriberTimingEvent}s when subscribers exceed a certain time. This does not interrupt subscriber processing
71-
* and is published after the subscriber finishes. The service can log a warning for SubscriberTimingEvents, see the
72-
* constructor {@link ThreadSafeEventService (long, boolean)}. The timing is checked for veto subscribers too.
73-
* </p>
7468
* <h2>Logging</h2>
7569
* <p>
7670
* All logging goes through the {@link Logger}. The Logger is configurable and supports multiple logging systems.
@@ -123,7 +117,7 @@
123117
* <p>
124118
* Once the cleanup start threshold is exceeded, a <tt>java.util.Timer</tt> is started to clean up stale subscribers periodically
125119
* in another thread. The timer will fire every <tt>cleanupPeriodMS</tt> milliseconds, which is set to the
126-
* <tt>CLEANUP_PERIOD_MS_DEFAULT<tt> (20 minutes) by default. The default is overridable in the constructor or
120+
* <tt>CLEANUP_PERIOD_MS_DEFAULT</tt> (20 minutes) by default. The default is overridable in the constructor or
127121
* via #setCleanupPeriodMS(Integer). If set to null, cleanup will not start. This is implemented with a <tt>java.util.Timer</tt>,
128122
* so Timer's warnings apply - setting this too low will cause cleanups to bunch up and hog the cleanup thread.
129123
* </p>
@@ -145,7 +139,6 @@
145139
* </p>
146140
*
147141
* @author Michael Bushe michael@bushe.com
148-
* @todo (param) a JMS-like selector (can be done in base classes by implements like a commons filter
149142
* @see EventService for a complete description of the API
150143
*/
151144
@SuppressWarnings({"unchecked"})

0 commit comments

Comments
 (0)