Heart: javadoc

stephengold · Sep 27, 2023 · fac4780 · fac4780
1 parent 2418ebc
commit fac4780
Showing 1 changed file with 4 additions and 3 deletions.
diff --git a/HeartLibrary/src/main/java/jme3utilities/Heart.java b/HeartLibrary/src/main/java/jme3utilities/Heart.java
@@ -72,7 +72,8 @@ OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 import jme3utilities.math.VectorXZ;
 
 /**
- * Miscellaneous utility methods in the Heart Library.
+ * Miscellaneous utility methods in the Heart Library. All methods should be
+ * static.
  *
  * @author Stephen Gold sgold@sonic.net
  */
@@ -535,9 +536,9 @@ public static String version() {
     }
 
     /**
-     * Read the terse version string for this library.
+     * Return the terse version string for this library.
      *
-     * @return branch and revision (not null, not empty)
+     * @return the branch name and revision string (not null, not empty)
      */
     public static String versionShort() {
         String verbose = version();