From af621a92250681a83e76293e7d33f685a0fc07e6 Mon Sep 17 00:00:00 2001 From: Sven Gothel Date: Fri, 28 Feb 2014 15:31:12 +0100 Subject: Bug 801: Enhance API doc of FontSet and FontFactory --- .../classes/com/jogamp/graph/font/FontFactory.java | 4 ++-- .../classes/com/jogamp/graph/font/FontSet.java | 24 ++++++++++++++-------- 2 files changed, 18 insertions(+), 10 deletions(-) (limited to 'src/jogl/classes/com/jogamp/graph') diff --git a/src/jogl/classes/com/jogamp/graph/font/FontFactory.java b/src/jogl/classes/com/jogamp/graph/font/FontFactory.java index 884662e6e..d39bda004 100644 --- a/src/jogl/classes/com/jogamp/graph/font/FontFactory.java +++ b/src/jogl/classes/com/jogamp/graph/font/FontFactory.java @@ -50,10 +50,10 @@ public class FontFactory { private static final String FontConstructorPropKey = "jogamp.graph.font.ctor"; private static final String DefaultFontConstructor = "jogamp.graph.font.typecast.TypecastFontConstructor"; - /** Ubuntu is the default font family */ + /** Ubuntu is the default font family, {@value} */ public static final int UBUNTU = 0; - /** Java fonts are optional */ + /** Java fonts are optional, {@value} */ public static final int JAVA = 1; private static final FontConstructor fontConstr; diff --git a/src/jogl/classes/com/jogamp/graph/font/FontSet.java b/src/jogl/classes/com/jogamp/graph/font/FontSet.java index 17b8b2136..60a16b241 100644 --- a/src/jogl/classes/com/jogamp/graph/font/FontSet.java +++ b/src/jogl/classes/com/jogamp/graph/font/FontSet.java @@ -32,30 +32,38 @@ import java.io.IOException; public interface FontSet { - /** Font family REGULAR **/ + /** Font family REGULAR, {@value} **/ public static final int FAMILY_REGULAR = 0; - /** Font family LIGHT **/ + /** Font family LIGHT, {@value} **/ public static final int FAMILY_LIGHT = 1; - /** Font family MEDIUM **/ + /** Font family MEDIUM, {@value} **/ public static final int FAMILY_MEDIUM = 2; - /** Font family CONDENSED **/ + /** Font family CONDENSED, {@value} **/ public static final int FAMILY_CONDENSED = 3; - /** Font family MONO **/ + /** Font family MONO, {@value} **/ public static final int FAMILY_MONOSPACED = 4; - /** SERIF style/family bit flag. Fallback to Sans Serif. */ + /** Zero style, {@value} */ + public static final int STYLE_NONE = 0; + + /** SERIF style/family bit flag. Fallback to Sans Serif, {@value} */ public static final int STYLE_SERIF = 1 << 1; - /** BOLD style bit flag */ + /** BOLD style bit flag, {@value} */ public static final int STYLE_BOLD = 1 << 2; - /** ITALIC style bit flag */ + /** ITALIC style bit flag, {@value} */ public static final int STYLE_ITALIC = 1 << 3; + /** + * Returns the family {@link #FAMILY_REGULAR} with {@link #STYLE_NONE} + * as retrieved with {@link #get(int, int)}. + * @throws IOException + */ Font getDefault() throws IOException ; Font get(int family, int stylebits) throws IOException ; -- cgit v1.2.3