Replace <h1> tags with <strong> tags in BranchDisplacementDurationFea…

…ture and BranchNSpotsFeature javadoc * Reasoning: the javadoc rules where complaining about multiple <h1>-tags used in a row. "unexpected heading used: <H1>, compared to implicit preceding heading: <H1>"
mastodon-sc · Feb 21, 2024 · d51bbfd · d51bbfd
1 parent fa7111f
commit d51bbfd
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 18 deletions.
diff --git a/src/main/java/org/mastodon/mamut/feature/branch/BranchDisplacementDurationFeature.java b/src/main/java/org/mastodon/mamut/feature/branch/BranchDisplacementDurationFeature.java
@@ -63,8 +63,8 @@
  * in the lineage tree.
  * <p>
  * Cf. following example:
- *
- * <h1>Model-Graph (i.e. Graph of Spots)</h1>
+ * <p>
+ * <strong>Model-Graph (i.e. Graph of Spots)</strong>
  *
  * <pre>
  *                                                Spot( 0, X=1,00, Y=2,00, Z=3,00, tp=0 )
@@ -91,7 +91,7 @@
  *                                               Spot( 10, X=11,00, Y=22,00, Z=33,00, tp=7 )  Spot( 7, X=8,00, Y=16,00, Z=24,00, tp=7 )
  * </pre>
  *
- * <h1>Branch-Graph (i.e. Graph of BranchSpots)</h1>
+ * <strong>Branch-Graph (i.e. Graph of BranchSpots)</strong>
  *
  * <pre>
  *                        branchSpotA
@@ -103,7 +103,7 @@
  *                                  branchSpotD    branchSpotE
  * </pre>
  *
- * <h1>Duration</h1>
+ * <strong>Duration</strong>
  * <ul>
  * <li>{@code branchSpotA = 2}</li>
  * <li>{@code branchSpotB = 2}</li>
@@ -112,7 +112,7 @@
  * <li>{@code branchSpotE = 3}</li>
  * </ul>
  *
- * <h1>Displacement</h1>
+ * <strong>Displacement</strong>
  * <ul>
  * <li>{@code branchSpot0 = Math.sqrt( 4+16+36 )}</li>
  * <li>{@code branchSpot1 = Math.sqrt( 4+16+36 )}</li>
@@ -122,7 +122,7 @@
  * </ul>
  *
  *
- * <h1>Spot-Graph</h1>
+ * <strong>Spot-Graph</strong>
  *
  * <pre>
  *    Spot( 0, X=1,00, Y=2,00, Z=3,00, tp=0 )
@@ -140,14 +140,16 @@
  *  Spot( 4, X=5,00, Y=10,00, Z=15,00, tp=3 )
  * </pre>
  *
- * <h1>BranchSpot-Graph</h1> branchSpot0
- *
- * <h1>Duration</h1>
+ * <strong>BranchSpot-Graph</strong>
+ * <p>
+ * branchSpot0
+ * <p>
+ * <strong>Duration</strong>
  * <ul>
  * <li>{@code branchSpot0 = 4}</li>
  * </ul>
  *
- * <h1>Displacement</h1>
+ * <strong>Displacement</strong>
  * <ul>
  * <li>{@code branchSpot0 = Math.sqrt(16+64+144)}</li>
  * </ul>

diff --git a/src/main/java/org/mastodon/mamut/feature/branch/BranchNSpotsFeature.java b/src/main/java/org/mastodon/mamut/feature/branch/BranchNSpotsFeature.java
@@ -53,8 +53,8 @@
  * be equivalent to {@link BranchDisplacementDurationFeature} (duration).
  * However, in situations where there are spots missing within a branch spot, this
  * may well be different.
- *
- * <h1>Model-Graph (i.e. Graph of Spots)</h1>
+ * <p>
+ * <strong>Model-Graph (i.e. Graph of Spots)</strong>
  *
  * <pre>
  *                                                Spot( 0, X=1,00, Y=2,00, Z=3,00, tp=0 )
@@ -81,7 +81,7 @@
  *                                               Spot( 10, X=11,00, Y=22,00, Z=33,00, tp=7 )  Spot( 7, X=8,00, Y=16,00, Z=24,00, tp=7 )
  * </pre>
  *
- * <h1>Branch-Graph (i.e. Graph of BranchSpots)</h1>
+ * <strong>Branch-Graph (i.e. Graph of BranchSpots)</strong>
  *
  * <pre>
  *                        branchSpotA
@@ -102,7 +102,7 @@
  * </ul>
  *
  *
- * <h1>Model-Graph (i.e. Graph of Spots)</h1>
+ * <strong>Model-Graph (i.e. Graph of Spots)</strong>
  *
  * <pre>
  *    Spot( 0, X=1,00, Y=2,00, Z=3,00, tp=0 )
@@ -120,14 +120,15 @@
  *  Spot( 4, X=5,00, Y=10,00, Z=15,00, tp=3 )
  * </pre>
  *
- * <h1>Branch-Graph (i.e. Graph of BranchSpots)</h1>
- *   branchSpot0
+ * <strong>Branch-Graph (i.e. Graph of BranchSpots)</strong>
+ * <p>
+ * branchSpot0
  *
  * <ul>
  * <li>{@code branchSpot0 = 5}</li>
  * </ul>
  *
- * <h1>Model-Graph (i.e. Graph of Spots)</h1>
+ * <strong>Model-Graph (i.e. Graph of Spots)</strong>
  * <pre>
  *                                                Spot( 0, X=1,00, Y=2,00, Z=3,00, tp=0 )
  *                                                                   │
@@ -152,7 +153,7 @@
  *                                                                    │                                           │
  *                                               Spot( 10, X=11,00, Y=22,00, Z=33,00, tp=7 )  Spot( 7, X=8,00, Y=16,00, Z=24,00, tp=7 )
  * </pre>
- * <h1>Branch-Graph (i.e. Graph of BranchSpots)</h1>
+ * <strong>Branch-Graph (i.e. Graph of BranchSpots)</strong>
  * <pre>
  *                        branchSpotA
  * 	       ┌──────────────┴─────────────────┐