Skip to content

Commit d91ed2f

Browse files
dschoctrueden
authored andcommitted
Document the implicit inputs in ModuleInfo's Javadoc
This is hopefully the most logical place. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de>
1 parent aa8bbf4 commit d91ed2f

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@
4040
* A ModuleInfo object encapsulates metadata about a particular {@link Module}
4141
* (but not a specific instance of it). In particular, it can report details on
4242
* the names and types of inputs and outputs.
43+
* <p>
44+
* A special class of implicit input parameters is available: when the
45+
* {@code name} starts with a dot (e.g. {@code .helloWorld}), no warning is
46+
* issued about an unmatched input.
47+
* </p>
4348
*
4449
* @author Aivar Grislis
4550
* @author Curtis Rueden

0 commit comments

Comments
 (0)