Skip to content

Commit 7d23998

Browse files
committed
Add missing javadoc
1 parent 40f90fc commit 7d23998

File tree

4 files changed

+10
-5
lines changed

4 files changed

+10
-5
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
import org.scijava.Typed;
3333

3434
/**
35-
* TODO
35+
* Interface for plugins that act as factories, creating objects on demand.
3636
*
3737
* @author Curtis Rueden
3838
* @param <D> Source data type.

src/main/java/org/scijava/search/SearchActionFactory.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,12 @@
3232
import org.scijava.plugin.FactoryPlugin;
3333

3434
/**
35-
* TODO
35+
* SciJava plugin type for doing something with a {@link SearchResult}.
36+
* <p>
37+
* For example, {@code RunModuleSearchActionFactory} creates a
38+
* {@link SearchAction} that executes the SciJava module described by a
39+
* {@code ModuleSearchResult}.
40+
* </p>
3641
*
3742
* @author Curtis Rueden
3843
*/

src/main/java/org/scijava/search/SearchListener.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,6 @@
3737
*/
3838
public interface SearchListener {
3939

40-
/** TODO */
40+
/** Invoked when a search is completed. */
4141
void searchCompleted(SearchEvent event);
4242
}

src/main/java/org/scijava/search/SearchService.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,10 @@ default List<SearchAction> actions(final SearchResult result) {
6969
.map(factory -> factory.create(result)).collect(Collectors.toList());
7070
}
7171

72-
/** TODO javadoc */
72+
/** Gets whether the given searcher plugin is currently enabled. */
7373
boolean enabled(Searcher s);
7474

75-
/** TODO javadoc */
75+
/** Enables or disables the given searcher plugin. */
7676
void setEnabled(Searcher s, boolean enabled);
7777

7878
@Override

0 commit comments

Comments
 (0)