Skip to content

Commit a2fe41c

Browse files
committed
HeadlessUI: improve the javadoc
1 parent 858f188 commit a2fe41c

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

src/main/java/org/scijava/ui/headless/HeadlessUI.java

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,17 +35,20 @@
3535

3636
import org.scijava.Priority;
3737
import org.scijava.display.Display;
38+
import org.scijava.log.LogService;
3839
import org.scijava.plugin.AbstractRichPlugin;
3940
import org.scijava.plugin.Plugin;
4041
import org.scijava.ui.DialogPrompt;
41-
import org.scijava.ui.UIService;
4242
import org.scijava.ui.UserInterface;
4343
import org.scijava.ui.viewer.DisplayWindow;
4444
import org.scijava.util.ListUtils;
4545

4646
/**
47-
* A "null object" {@link UIService} implementation used when the application is
48-
* running headless.
47+
* A no-op user interface used when the application is running headless.
48+
* <p>
49+
* Most operations do nothing. Attempting to show an object via one of the
50+
* {@link #show} methods logs the object via the {@link LogService}.
51+
* </p>
4952
*
5053
* @author Richard Domander (Royal Veterinary College, London)
5154
* @author Curtis Rueden

0 commit comments

Comments
 (0)