summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorSven Gothel <[email protected]>2014-02-28 15:31:12 +0100
committerSven Gothel <[email protected]>2014-02-28 15:31:12 +0100
commitaf621a92250681a83e76293e7d33f685a0fc07e6 (patch)
tree5238ef2669aaa49fc4ea6c9be79580478b505007
parent7e4ac89fc561f4b106bda377998a8b3e1dee7c1d (diff)
Bug 801: Enhance API doc of FontSet and FontFactory
-rw-r--r--src/jogl/classes/com/jogamp/graph/font/FontFactory.java4
-rw-r--r--src/jogl/classes/com/jogamp/graph/font/FontSet.java24
2 files changed, 18 insertions, 10 deletions
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 ;