Skip to content

Commit c742815

Browse files
committed
Remove ImageJ-isms
While the ImageJ2 project incubated much of the SciJava Common functionality, that functionality is no longer limited to just ImageJ. This commit updates the language accordingly in various places.
1 parent a3efd9a commit c742815

26 files changed

+64
-70
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,8 @@
7272
* @author Grant Harris
7373
* @see ModuleInfo - The interface which provides many methods for interrogating
7474
* structural details of a {@link Module}.
75-
* @see CommandModule - An adapter class that bridges the gap between ImageJ
76-
* commands and the rich {@link Module} interface.
75+
* @see CommandModule - An adapter class that bridges the gap between
76+
* {@link Command}s and the rich {@link Module} interface.
7777
*/
7878
public class CommandInfo extends PluginInfo<Command> implements ModuleInfo {
7979

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,21 +54,21 @@
5454
* with inputs and outputs.
5555
* </p>
5656
* <p>
57-
* Conceptually, an ImageJ command is such a piece of functionality. However,
58-
* the {@link Command} interface is intended to be as simple to implement as
57+
* Conceptually, a command is such a piece of functionality. However, the
58+
* {@link Command} interface is intended to be as simple to implement as
5959
* possible; the only required method is {@link Command#run()}, which is
6060
* inherited from {@link Runnable}. The command's inputs and outputs are
6161
* indicated using @{@link Parameter} annotations.
6262
* </p>
6363
* <p>
64-
* To bridge the gap, this class adapts an ImageJ {@link Command} instance into
65-
* an object that fully implements the {@link Module} interface.
64+
* To bridge the gap, this class adapts a {@link Command} instance into an
65+
* object that fully implements the {@link Module} interface.
6666
* </p>
6767
*
6868
* @author Curtis Rueden
6969
* @author Johannes Schindelin
7070
* @author Grant Harris
71-
* @see CommandInfo - An adapter class that bridges the gap between ImageJ
71+
* @see CommandInfo - An adapter class that bridges the gap between SciJava
7272
* commands and the rich {@link ModuleInfo} interface.
7373
* @see Module - The interface which provides many methods for interrogating an
7474
* encapsulated piece of functionality with inputs and outputs.

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,10 @@
3535
import org.scijava.Cancelable;
3636

3737
/**
38-
* An ImageJ command that knows its context. Its service parameters are
39-
* automatically populated when {@link #setContext} is called, to make it easier
40-
* to use via Java API calls (i.e., without invoking it via
41-
* {@link CommandService#run}). This improves compile-time safety of downstream
42-
* code that calls the command.
38+
* A command that knows its context. Its service parameters are automatically
39+
* populated when {@link #setContext} is called, to make it easier to use via
40+
* Java API calls (i.e., without invoking it via {@link CommandService#run}).
41+
* This improves compile-time safety of downstream code that calls the command.
4342
* <p>
4443
* Here is an example command execution using {@link CommandService#run}:
4544
* </p>

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@
4242
import org.scijava.util.ClassUtils;
4343

4444
/**
45-
* An ImageJ command with a variable number of inputs and outputs. This class
46-
* provides greater configurability, but also greater complexity, than
47-
* implementing the {@link Command} interface and using only @{@link Parameter}
48-
* annotations on instance fields.
45+
* A command with a variable number of inputs and outputs. This class provides
46+
* greater configurability, but also greater complexity, than implementing the
47+
* {@link Command} interface and using only @{@link Parameter} annotations on
48+
* instance fields.
4949
*
5050
* @author Curtis Rueden
5151
*/

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
import org.scijava.thread.ThreadService;
4444

4545
/**
46-
* An ImageJ command intended to be run interactively.
46+
* A command intended to be run interactively.
4747
* <p>
4848
* It is {@link Interactive} and {@link Previewable}, with the previews used for
4949
* interactive exploration.

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,9 @@
3939
import org.scijava.plugin.Parameter;
4040

4141
/**
42-
* An ImageJ command which implements {@link Module} directly (rather than using
43-
* the {@link CommandModule} adapter class). This is useful for commands which
44-
* want to inspect and manipulate their own inputs and outputs programmatically.
42+
* A command which implements {@link Module} directly (rather than using the
43+
* {@link CommandModule} adapter class). This is useful for commands which want
44+
* to inspect and manipulate their own inputs and outputs programmatically.
4545
*
4646
* @author Curtis Rueden
4747
*/

src/main/java/org/scijava/console/ConsoleService.java

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,7 @@ public interface ConsoleService extends
5050
HandlerService<LinkedList<String>, ConsoleArgument>, SciJavaService
5151
{
5252

53-
/**
54-
* Handles arguments to ImageJ coming from an external source such as the
55-
* command line.
56-
*/
53+
/** Handles arguments from an external source such as the command line. */
5754
void processArgs(String... args);
5855

5956
/** Adds a listener for output sent to {@code stdout} or {@code stderr}. */

src/main/java/org/scijava/display/event/input/MsButtonEvent.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@
4343
public abstract class MsButtonEvent extends MsEvent {
4444

4545
// TODO - Use an enum for the buttons. Perhaps an extensible enum (see Axis &
46-
// Axes)? In util-awt, add a mechanism for mapping AWT mouse buttons to and
47-
// from ImageJ mouse buttons (similar to AWTCursors).
46+
// Axes)? In scijava-ui-awt, add a mechanism for mapping AWT mouse buttons to
47+
// and from SciJava mouse buttons (similar to AWTCursors).
4848

4949
public static final int LEFT_BUTTON = 0;
5050
public static final int MIDDLE_BUTTON = 1;

src/main/java/org/scijava/menu/MenuConstants.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
package org.scijava.menu;
3333

3434
/**
35-
* Useful constants when defining ImageJ menu entries.
35+
* Useful constants when defining application menu entries.
3636
*
3737
* @author Curtis Rueden
3838
*/
@@ -43,9 +43,9 @@ private MenuConstants() {
4343
}
4444

4545
// TODO - Finalize the location of these constants. The potential confusion is
46-
// that ij-core supposedly provides a general-purpose extensibility framework,
47-
// which could be used by applications other than ImageJ, except for these
48-
// constants, which are very specific to the ImageJ user interface.
46+
// that SciJava Common supposedly provides a general-purpose extensibility
47+
// framework, which could be used by applications other than ImageJ, except
48+
// for these constants, which are very specific to the ImageJ user interface.
4949

5050
public static final String FILE_LABEL = "File";
5151
public static final String EDIT_LABEL = "Edit";

src/main/java/org/scijava/module/ModuleService.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,10 @@
5959
* </p>
6060
* <p>
6161
* A <em>module</em> is distinct from a <em>plugin</em> in that plugins extend
62-
* ImageJ's functionality in some way, taking many forms, whereas modules are
63-
* always runnable code with typed inputs and outputs. There is a particular
64-
* type of plugin called a {@link org.scijava.command.Command} which is also a
65-
* module, but many plugins (e.g., {@link org.scijava.tool.Tool}s and
62+
* a program's functionality in some way, taking many forms, whereas modules
63+
* are always runnable code with typed inputs and outputs. There is a
64+
* particular type of plugin called a {@link org.scijava.command.Command} which
65+
* is also a module, but many plugins (e.g., {@link org.scijava.tool.Tool}s and
6666
* {@link org.scijava.display.Display}s) are not modules.
6767
* </p>
6868
*

0 commit comments

Comments
 (0)