Skip to content

Commit 43c0d16

Browse files
committed
Attempt to reinstate javadoc generation
1 parent 375385d commit 43c0d16

54 files changed

Lines changed: 200 additions & 487 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎pom.xml‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -182,15 +182,16 @@
182182
<!--
183183
WORKAROUND: jzy3d-native-jogl-awt has an invalid automatic module
184184
name ('native' is a Java keyword), causing javadoc generation to fail
185-
with "Unable to derive module descriptor". failOnError=false allows
186-
the release to proceed. Remove once jzy3d publishes a fixed jar with
187-
a valid Automatic-Module-Name in its manifest. See also:
188-
https://github.com/jzy3d/jzy3d-api/issues
185+
with "Unable to derive module descriptor". legacyMode bypasses JPMS
186+
module-path resolution entirely, using classpath instead. Remove once
187+
jzy3d publishes a fixed jar with a valid Automatic-Module-Name in
188+
its manifest. See also: https://github.com/jzy3d/jzy3d-api/issues
189189
-->
190190
<plugin>
191191
<groupId>org.apache.maven.plugins</groupId>
192192
<artifactId>maven-javadoc-plugin</artifactId>
193193
<configuration>
194+
<legacyMode>true</legacyMode>
194195
<failOnError>false</failOnError>
195196
</configuration>
196197
</plugin>

‎src/main/java/sc/fiji/snt/PathFitter.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,10 @@
6060
* List<PathFitter> fitters = paths.stream()
6161
* .map(p -> new PathFitter(img, p))
6262
* .collect(Collectors.toList());
63-
*
63+
* <p>
6464
* // Parallel fitting
6565
* fitters.parallelStream().forEach(PathFitter::call);
66-
*
66+
* <p>
6767
* // Sequential application
6868
* fitters.forEach(PathFitter::applyFit);
6969
* }

‎src/main/java/sc/fiji/snt/SearchProgressCallback.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@
2424

2525
import sc.fiji.snt.tracing.SearchInterface;
2626

27+
/**
28+
* Callback interface for monitoring progress of a search operation during path tracing.
29+
* Provides updates on points evaluated, completion status, and thread state changes.
30+
*/
2731
public interface SearchProgressCallback {
2832

2933
/* How many points have we considered? */

‎src/main/java/sc/fiji/snt/analysis/PersistenceAnalyzer.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@ public List<Double> getBarcode(final String descriptor) throws UnknownMetricExce
456456
* <strong>Correspondence:</strong> The order of node pairs matches the order of birth-death pairs
457457
* returned by {@link #getDiagram(String)}, allowing direct correlation between topological
458458
* features and their spatial locations.
459-
*
459+
* <p>
460460
* <strong>Example Usage:</strong>
461461
* <pre>{@code
462462
* List<List<Double>> diagram = analyzer.getDiagram("geodesic");

‎src/main/java/sc/fiji/snt/analysis/UnknownMetricException.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@
2222

2323
package sc.fiji.snt.analysis;
2424

25+
/**
26+
* Exception thrown when a requested metric is not available or recognized.
27+
*/
2528
public class UnknownMetricException extends IllegalArgumentException {
2629
private static final long serialVersionUID = 1L;
2730

‎src/main/java/sc/fiji/snt/event/SNTEvent.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@
2222

2323
package sc.fiji.snt.event;
2424

25+
/**
26+
* Base event class for SNT events. Represents various application-level events
27+
* such as quit, exit, and data transfer operations.
28+
*/
2529
public class SNTEvent {
2630

2731
/** Event type indicating no specific event */

‎src/main/java/sc/fiji/snt/event/SNTListener.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,10 @@
2222

2323
package sc.fiji.snt.event;
2424

25+
/**
26+
* Listener interface for SNT events. Implementers are notified when
27+
* SNT events occur.
28+
*/
2529
public interface SNTListener {
2630

2731
/**

‎src/main/java/sc/fiji/snt/gui/CheckboxSpinner.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,10 @@
2525
import javax.swing.*;
2626
import java.awt.*;
2727

28+
/**
29+
* A custom GUI component combining a checkbox and spinner control in a single panel.
30+
* Useful for options where a numeric parameter can be enabled or disabled with a checkbox.
31+
*/
2832
public class CheckboxSpinner extends JPanel {
2933

3034
private static final long serialVersionUID = 937359242995500492L;

‎src/main/java/sc/fiji/snt/gui/ColorChooserButton.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727

2828
/**
2929
* Creates a JButton holding a color chooser. It is based on
30-
* https://stackoverflow.com/a/30433662 released under cc-by-sa
30+
* <a href="https://stackoverflow.com/a/30433662">...</a> released under cc-by-sa
3131
*/
3232
public class ColorChooserButton extends JButton {
3333

‎src/main/java/sc/fiji/snt/gui/ComponentMover.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@
3232
* moved can be a high level Window (ie. Window, Frame, Dialog) in which case
3333
* the Window is moved within the desktop. Or the Component can belong to a
3434
* Container in which case the Component is moved within the Container.
35-
*
35+
* <p>
3636
* When moving a Window, the listener can be added to a child Component of
3737
* the Window. In this case attempting to move the child will result in the
3838
* Window moving. For example, you might create a custom "Title Bar" for an
3939
* undecorated Window and moving of the Window is accomplished by moving the
4040
* title bar only. Multiple components can be registered as "window movers".
41-
*
41+
* <p>
4242
* Components can be registered when the class is created. Additional
4343
* components can be added at any time using the registerComponent() method.
4444
*/
@@ -237,7 +237,7 @@ public void setSnapSize(Dimension snapSize)
237237

238238
/**
239239
* Setup the variables used to control the moving of the component:
240-
*
240+
* <p>
241241
* source - the source component of the mouse event
242242
* destination - the component that will ultimately be moved
243243
* pressed - the Point where the mouse was pressed in the destination

0 commit comments

Comments
 (0)