Skip to content

Commit f020930

Browse files
committed
FIX: TrackDataCache Javadoc in some methods
1 parent 94782c5 commit f020930

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

src/main/java/net/celltrackingchallenge/measures/TrackDataCache.java

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,10 @@ public class TrackDataCache
5757
///shortcuts to some Fiji services
5858
private final Logger log;
5959

60-
///a constructor requiring connection to Fiji report/log services
60+
/**
61+
* Construct and connect to Fiji report/log services.
62+
* @param _log Logger from the scijava
63+
*/
6164
public TrackDataCache(final Logger _log)
6265
{
6366
//check that non-null was given for _log!
@@ -75,7 +78,13 @@ public TrackDataCache(final Logger _log)
7578
///GT and RES paths combination for which this cache is valid, null means invalid
7679
private String resPath = null;
7780

78-
///reference-based-only check if the parameters are those on which this cache was computed
81+
/**
82+
* Reference-based-only check if the parameters are those on which this cache was computed.
83+
*
84+
* @param _gtPath Was this cache recently operated against this GT data folder?
85+
* @param _resPath Was this cache recently operated against this result data folder?
86+
* @return Returns true if this cache was operated also against the provided folders.
87+
*/
7988
public boolean validFor(final String _gtPath, final String _resPath)
8089
{
8190
return ( gtPath != null && resPath != null

0 commit comments

Comments
 (0)