Skip to content

Commit 4a77162

Browse files
committed
Rework the text of the example.
1 parent fbfd3d5 commit 4a77162

1 file changed

Lines changed: 5 additions & 6 deletions

File tree

src/test/java/fiji/plugin/trackmate/util/cli/ExampleCommandCLI.java

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public ExampleCommandCLI()
2222
/*
2323
* The executable that will be called by the TrackMate module.
2424
*
25-
* CLI configs that inherit from '>CommandCLIConfigurator' are all based
25+
* CLI configs that inherit from 'CommandCLIConfigurator' are all based
2626
* on an actual executable, that is a file with exec rights somewhere on
2727
* the user computer. They need to set it themselves, so the config part
2828
* only specifies the name, the help and the key of this command.
@@ -45,13 +45,12 @@ public ExampleCommandCLI()
4545
* is what is passed to it before the value.
4646
*
4747
* This example argument is not required, but has a default value of 1.
48-
* The default value is used to initialize the UI widgets, but also in
49-
* the command line. If an argument is not required, is not set, but has
50-
* a default value, then the argument will appear in the command line
51-
* with this default value.
48+
* The default value is used only in the command line. If an argument is
49+
* not required, is not set, but has a default value, then the argument
50+
* will appear in the command line with this default value.
5251
*
5352
* Adding arguments is done via 'adder' methods, that are only visible
54-
* in inhering class. The 'get()' method of the adder returns the
53+
* in inhering classes. The 'get()' method of the adder returns the
5554
* created argument. It also adds it to the inner parts of the mother
5655
* class, so that it is handled automatically when creating a GUI or a
5756
* command line. But it is a good idea to expose it in this concrete

0 commit comments

Comments
 (0)