Typecast Font: Add API doc for getLineHeight(), remove unused Vec3f import

1 files changed, 14 insertions, 2 deletions

diff --git a/src/jogl/classes/com/jogamp/graph/font/Font.java b/src/jogl/classes/com/jogamp/graph/font/Font.java
index 7299d6128..96e0cc523 100644
--- a/src/jogl/classes/com/jogamp/graph/font/Font.java
+++ b/src/jogl/classes/com/jogamp/graph/font/Font.java
@@ -29,7 +29,6 @@ package com.jogamp.graph.font;
 
 import com.jogamp.graph.curve.OutlineShape;
 import com.jogamp.graph.geom.plane.AffineTransform;
-import com.jogamp.opengl.math.Vec3f;
 import com.jogamp.opengl.math.geom.AABBox;
 
 /**
@@ -352,7 +351,20 @@ public interface Font {
     int getLineHeightFU();
 
     /**
-     * Return line height in font em-size [0..1]
+     * Return line height, baseline-to-baseline in em-size [0..1], composed from `hhea' table entries.
+     * <pre>
+     *   return ascent - descent + linegap;
+     * </pre>
+     * or
+     * <pre>
+     *   // lineGap positive value
+     *   // descent negative value
+     *   // ascent positive value
+     *   return ascent - descent + linegap;
+     * </pre>
+     * @see Metrics#getAscent()
+     * @see Metrics#getDescent()
+     * @see Metrics#getLineGap()
      */
     float getLineHeight();