Skip to content

Commit 68f1131

Browse files
committed
Remove imagej-isms from javadoc
1 parent 689acb0 commit 68f1131

File tree

7 files changed

+44
-41
lines changed

7 files changed

+44
-41
lines changed

src/main/java/org/scijava/command/CommandService.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ <CT extends Command> List<CommandInfo> getCommands(
9090
* Gets the list of commands of the given class.
9191
* <p>
9292
* Most classes will have only a single match, but some special classes (such
93-
* as {@code imagej.legacy.LegacyCommand}) may match many entries.
93+
* as ImageJ's {@code LegacyCommand}) may match many entries.
9494
* </p>
9595
*/
9696
<C extends Command> List<CommandInfo> getCommandsOfClass(
@@ -100,7 +100,7 @@ <C extends Command> List<CommandInfo> getCommandsOfClass(
100100
* Gets the list of commands with the given class name.
101101
* <p>
102102
* Most classes will have only a single match, but some special classes (such
103-
* as {@code imagej.legacy.LegacyCommand}) may match many entries.
103+
* as ImageJ's {@code LegacyCommand}) may match many entries.
104104
* </p>
105105
*/
106106
List<CommandInfo> getCommandsOfClass(String className);

src/main/java/org/scijava/display/Display.java

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,7 @@
3838

3939
/**
4040
* A display is a particular type of plugin intended to collect objects for
41-
* visualization. The most common type of display is the
42-
* {@code net.imagej.display.ImageDisplay}, which displays images. However, in
43-
* principle there are no limits to the sorts of objects that can be handled.
41+
* visualization. For example, a {@link TextDisplay} displays {@link String}s.
4442
* <p>
4543
* Displays discoverable at runtime must implement this interface and be
4644
* annotated with @{@link Plugin} with attribute {@link Plugin#type()} =
@@ -86,11 +84,11 @@ public interface Display<T> extends List<T>, RichPlugin {
8684
* <p>
8785
* Note that this method may behave differently than {@link #contains}; in
8886
* general, any time {@link #contains} returns true, this method will also
89-
* return true, but not vice versa. For example, an
90-
* {@code imagej.data.display.ImageDisplay} is a {@code Display<DataView>} but
91-
* calling {@code isDisplaying} an a {@code Dataset} (which is not a
92-
* {@code DataView}) will return true if the {@code ImageDisplay} currently
93-
* contains a {@code DatasetView} that wraps that {@code Dataset}.
87+
* return true, but not vice versa. For example, in ImageJ, an
88+
* {@code ImageDisplay} is a {@code Display<DataView>} but calling
89+
* {@code isDisplaying} on a {@code Dataset} (which is not a {@code DataView})
90+
* will return true if the {@code ImageDisplay} currently contains a
91+
* {@code DatasetView} that wraps that {@code Dataset}.
9492
* </p>
9593
*/
9694
boolean isDisplaying(Object o);

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

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,15 @@ public interface EventService extends SciJavaService {
5454
* of a stack. For example:
5555
* </p>
5656
* <ol>
57-
* <li>@{code imagej.module.event.ModulesUpdatedEvent} is published with
57+
* <li>{@link org.scijava.module.event.ModulesUpdatedEvent} is published with
5858
* {@link #publish}.</li>
59-
* <li>{@code imagej.menu.DefaultMenuService} receives the event and handles
60-
* it, publishing {@code imagej.menu.event.MenusUpdatedEvent} in response.</li>
59+
* <li>{@link org.scijava.menu.DefaultMenuService} receives the event and
60+
* handles it, publishing {@link org.scijava.menu.event.MenusUpdatedEvent} in
61+
* response.</li>
6162
* <li>A third party that subscribes to both
62-
* {@code imagej.module.event.ModulesUpdatedEvent} and
63-
* {@code imagej.menu.event.MenusUpdatedEvent} will receive the latter before
64-
* the former.</li>
63+
* {@link org.scijava.module.event.ModulesUpdatedEvent} and
64+
* {@link org.scijava.menu.event.MenusUpdatedEvent} will receive the latter
65+
* before the former.</li>
6566
* </ol>
6667
* That said, the behavior of {@link #publish} depends on the thread from
6768
* which it is called: if called from a thread identified as a dispatch thread
@@ -84,14 +85,15 @@ public interface EventService extends SciJavaService {
8485
* resemble that of a queue. For example:
8586
* </p>
8687
* <ol>
87-
* <li>{@code imagej.module.event.ModulesUpdatedEvent} is published with
88+
* <li>{@link org.scijava.module.event.ModulesUpdatedEvent} is published with
8889
* {@link #publishLater}.</li>
89-
* <li>{@code imagej.menu.DefaultMenuService} receives the event and handles
90-
* it, publishing {@code imagej.menu.event.MenusUpdatedEvent} in response.</li>
90+
* <li>{@link org.scijava.menu.DefaultMenuService} receives the event and
91+
* handles it, publishing {@link org.scijava.menu.event.MenusUpdatedEvent} in
92+
* response.</li>
9193
* <li>A third party that subscribes to both
92-
* {@code imagej.module.event.ModulesUpdatedEvent} and
93-
* {@code imagej.menu.event.MenusUpdatedEvent} will receive the former first,
94-
* since it was already queued by the time the latter was published.</li>
94+
* {@link org.scijava.module.event.ModulesUpdatedEvent} and
95+
* {@link org.scijava.menu.event.MenusUpdatedEvent} will receive the former
96+
* first, since it was already queued by the time the latter was published.</li>
9597
* </ol>
9698
*/
9799
<E extends SciJavaEvent> void publishLater(E e);

src/main/java/org/scijava/object/DefaultObjectService.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,11 @@
5050
* registers new objects from {@link ObjectCreatedEvent}s, and removes objects
5151
* from {@link ObjectDeletedEvent}s.
5252
* <p>
53-
* This is useful to retrieve available objects of a particular type, such as
54-
* the list of {@code imagej.data.Dataset}s upon which a user can choose to
55-
* operate.
53+
* This is useful to retrieve available objects of a particular type. For
54+
* example, the {@link org.scijava.widget.InputHarvester} infrastructure uses it
55+
* to provide a pool of available objects for widgets such as the
56+
* {@link org.scijava.widget.ObjectWidget}, which provide the user with a
57+
* multiple-choice selection.
5658
* </p>
5759
*
5860
* @author Curtis Rueden

src/main/java/org/scijava/plugin/PTService.java

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,12 @@
4343
* few examples from ImageJ:
4444
* </p>
4545
* <ul>
46-
* <li>The {@code imagej.command.CommandService} works with
47-
* {@code imagej.command.Command}s.</li>
48-
* <li>The {@code imagej.text.TextService} works with
49-
* {@code imagej.text.TextFormat}s.</li>
50-
* <li>The {@code imagej.platform.PlatformService} works with
51-
* {@code imagej.platform.Platform}s.</li>
46+
* <li>The {@link org.scijava.command.CommandService} works with
47+
* {@link org.scijava.command.Command}s.</li>
48+
* <li>The {@link org.scijava.text.TextService} works with
49+
* {@link org.scijava.text.TextFormat}s.</li>
50+
* <li>The {@link org.scijava.platform.PlatformService} works with
51+
* {@link org.scijava.platform.Platform}s.</li>
5252
* </ul>
5353
* <p>
5454
* Most services fit this pattern in one way or another. When you wish to
@@ -58,12 +58,13 @@
5858
* </p>
5959
* <ul>
6060
* <li>A {@link SingletonService}, such as
61-
* {@code imagej.platform.PlatformService}, which manages
61+
* {@link org.scijava.platform.PlatformService}, which manages
6262
* {@link SingletonPlugin}s.</li>
63-
* <li>A {@link HandlerService}, such as {@code imagej.text.TextService}, which
64-
* manages {@link HandlerPlugin}s.</li>
65-
* <li>A {@link WrapperService}, such as {@code imagej.widget.WidgetService},
66-
* which manages {@link WrapperPlugin}s.</li>
63+
* <li>A {@link HandlerService}, such as {@link org.scijava.text.TextService},
64+
* which manages {@link HandlerPlugin}s.</li>
65+
* <li>A {@link WrapperService}, such as
66+
* {@link org.scijava.widget.WidgetService}, which manages
67+
* {@link WrapperPlugin}s.</li>
6768
* </ul>
6869
* <p>
6970
* It is named {@code PTService} rather than {@code PluginTypeService} or

src/main/java/org/scijava/plugin/PluginService.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ public interface PluginService extends SciJavaService {
114114
* Gets the list of plugins of the given class.
115115
* <p>
116116
* Most classes will have only a single match, but some special classes (such
117-
* as {@code imagej.legacy.LegacyCommand}) may match many entries.
117+
* as ImageJ's {@code LegacyCommand}) may match many entries.
118118
* </p>
119119
* <p>
120120
* Note that this method will result in {@link PluginInfo}s with matching
@@ -133,7 +133,7 @@ public interface PluginService extends SciJavaService {
133133
* Gets the list of plugins of the given class.
134134
* <p>
135135
* Most classes will have only a single match, but some special classes (such
136-
* as {@code imagej.legacy.LegacyCommand}) may match many entries.
136+
* as ImageJ's {@code LegacyCommand}) may match many entries.
137137
* </p>
138138
* <p>
139139
* Note that this method will result in {@link PluginInfo}s with matching
@@ -156,7 +156,7 @@ public interface PluginService extends SciJavaService {
156156
* Gets the list of plugins with the given class name.
157157
* <p>
158158
* Most classes will have only a single match, but some special classes (such
159-
* as {@code imagej.legacy.LegacyCommand}) may match many entries.
159+
* as ImageJ's {@code LegacyCommand}) may match many entries.
160160
* </p>
161161
*
162162
* @param className The class name for which to obtain the list of matching
@@ -168,7 +168,7 @@ public interface PluginService extends SciJavaService {
168168
* Gets the list of plugins with the given class name.
169169
* <p>
170170
* Most classes will have only a single match, but some special classes (such
171-
* as {@code imagej.legacy.LegacyCommand}) may match many entries.
171+
* as ImageJ's {@code LegacyCommand}) may match many entries.
172172
* </p>
173173
*
174174
* @param <PT> The <em>type</em> of plugins to look up; e.g.,

src/main/java/org/scijava/plugin/WrapperPlugin.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
* A plugin with a special "has-a" relationship (i.e., composition rather than
3636
* inheritance) with a single data object of a particular type.
3737
* <p>
38-
* For a concrete example, see ImageJ's {@code imagej.view.View}.
38+
* For a concrete example, see {@code org.scijava.widget.InputWidget}.
3939
* </p>
4040
*
4141
* @author Curtis Rueden

0 commit comments

Comments
 (0)