Skip to content

Commit de84489

Browse files
committed
LogMessage: improve javadoc
1 parent 7db7b91 commit de84489

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

src/main/java/org/scijava/log/LogMessage.java

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,18 @@
3838
import java.util.Date;
3939
import java.util.LinkedList;
4040

41+
import org.scijava.event.EventService;
42+
4143
/**
42-
* LogMessage represents a log message.
44+
* A log message broadcast by a {@link Logger}.
45+
* <p>
46+
* NB: The message is published <em>on the calling thread</em> by
47+
* {@link Logger#notifyListeners}, <em>not</em> on a dedicated event dispatch
48+
* thread by the {@link EventService}. This is done to avoid the overhead of the
49+
* event service's synchronized pub/sub implementation, as well as to avoid
50+
* potential infinite loops caused by debugging log messages surrounding event
51+
* publication.
52+
* </p>
4353
*
4454
* @author Matthias Arzt
4555
*/

0 commit comments

Comments
 (0)