Fixed JavaDoc in cogged code

We were not correctly double-bracing.
deshaw · Sep 18, 2024 · 423424a · 423424a
1 parent 6b120bc
commit 423424a
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 14 deletions.
diff --git a/java/src/main/java/com/deshaw/hypercube/CubeMath.java b/java/src/main/java/com/deshaw/hypercube/CubeMath.java
@@ -954,7 +954,7 @@ private CubeMath()
      *
      * @param shape   The shape of the cube to return.
      * @param kwargs  <ul>
-     *                  <li> -- The type for the cube.</li>
+     *                  <li>{@code dtype='float'} -- The type for the cube.</li>
      *                </ul>
      *
      * @throws NullPointerException          If any given cube was {@code null}.
@@ -1011,7 +1011,7 @@ else if (klass.equals(Boolean.class)) {
      *
      * @param shape   The shape of the cube to return.
      * @param kwargs  <ul>
-     *                  <li> -- The type for the cube.</li>
+     *                  <li>{@code dtype='float'} -- The type for the cube.</li>
      *                </ul>
      *
      * @throws NullPointerException          If any given cube was {@code null}.
@@ -1067,7 +1067,7 @@ else if (klass.equals(Boolean.class)) {
      *
      * @param shape   The shape of the cube to return.
      * @param kwargs  <ul>
-     *                  <li> -- The type for the cube.</li>
+     *                  <li>{@code dtype='float'} -- The type for the cube.</li>
      *                </ul>
      *
      * @throws NullPointerException          If any given cube was {@code null}.
@@ -1222,7 +1222,7 @@ else if (a.getElementType().equals(Boolean.class)) {
      * @param shift   The (signed) number of elements to roll this cube by or,
      *                if an array, in each axis.
      * @param kwargs  <ul>
-     *                  <li> -- The axis to roll or, if {@code shift}
+     *                  <li>{@code axis=0} -- The axis to roll or, if {@code shift}
      *                      is an array, a matching array of axes.</li>
      *                </ul>
      *
@@ -19110,4 +19110,4 @@ private static Hypercube<Double> doubleExtract(
     }
 }
 
- // [[[end]]] (checksum: 8ea171260fd529f3ec2fd754a2626cfc)
+ // [[[end]]] (checksum: b443f5bc78a350467ba95f44eec88238)
diff --git a/java/src/main/java/com/deshaw/hypercube/VectorizedCubeMath.java b/java/src/main/java/com/deshaw/hypercube/VectorizedCubeMath.java
@@ -1064,7 +1064,7 @@ private VectorizedCubeMath()
      *
      * @param shape   The shape of the cube to return.
      * @param kwargs  <ul>
-     *                  <li> -- The type for the cube.</li>
+     *                  <li>{@code dtype='float'} -- The type for the cube.</li>
      *                </ul>
      *
      * @throws NullPointerException          If any given cube was {@code null}.
@@ -1121,7 +1121,7 @@ else if (klass.equals(Boolean.class)) {
      *
      * @param shape   The shape of the cube to return.
      * @param kwargs  <ul>
-     *                  <li> -- The type for the cube.</li>
+     *                  <li>{@code dtype='float'} -- The type for the cube.</li>
      *                </ul>
      *
      * @throws NullPointerException          If any given cube was {@code null}.
@@ -1177,7 +1177,7 @@ else if (klass.equals(Boolean.class)) {
      *
      * @param shape   The shape of the cube to return.
      * @param kwargs  <ul>
-     *                  <li> -- The type for the cube.</li>
+     *                  <li>{@code dtype='float'} -- The type for the cube.</li>
      *                </ul>
      *
      * @throws NullPointerException          If any given cube was {@code null}.
@@ -1332,7 +1332,7 @@ else if (a.getElementType().equals(Boolean.class)) {
      * @param shift   The (signed) number of elements to roll this cube by or,
      *                if an array, in each axis.
      * @param kwargs  <ul>
-     *                  <li> -- The axis to roll or, if {@code shift}
+     *                  <li>{@code axis=0} -- The axis to roll or, if {@code shift}
      *                      is an array, a matching array of axes.</li>
      *                </ul>
      *
@@ -20709,4 +20709,4 @@ private static Hypercube<Double> doubleExtract(
     }
 }
 
-// [[[end]]] (checksum: 6bc4a24e22a374cc70ca58fee7aaf7a3)
+// [[[end]]] (checksum: a2a4afb92926291f893725534f0592de)
diff --git a/java/src/main/java/com/deshaw/hypercube/cube_math.py b/java/src/main/java/com/deshaw/hypercube/cube_math.py
@@ -486,7 +486,7 @@
      *
      * @param shape   The shape of the cube to return.
      * @param kwargs  <ul>
-     *                  <li>{@code dtype='float'} -- The type for the cube.</li>
+     *                  <li>{{@code dtype='float'}} -- The type for the cube.</li>
      *                </ul>
      *
      * @throws NullPointerException          If any given cube was {{@code null}}.
@@ -543,7 +543,7 @@
      *
      * @param shape   The shape of the cube to return.
      * @param kwargs  <ul>
-     *                  <li>{@code dtype='float'} -- The type for the cube.</li>
+     *                  <li>{{@code dtype='float'}} -- The type for the cube.</li>
      *                </ul>
      *
      * @throws NullPointerException          If any given cube was {{@code null}}.
@@ -599,7 +599,7 @@
      *
      * @param shape   The shape of the cube to return.
      * @param kwargs  <ul>
-     *                  <li>{@code dtype='float'} -- The type for the cube.</li>
+     *                  <li>{{@code dtype='float'}} -- The type for the cube.</li>
      *                </ul>
      *
      * @throws NullPointerException          If any given cube was {{@code null}}.
@@ -754,7 +754,7 @@
      * @param shift   The (signed) number of elements to roll this cube by or,
      *                if an array, in each axis.
      * @param kwargs  <ul>
-     *                  <li>{@code axis=0} -- The axis to roll or, if {{@code shift}}
+     *                  <li>{{@code axis=0}} -- The axis to roll or, if {{@code shift}}
      *                      is an array, a matching array of axes.</li>
      *                </ul>
      *