release: 1.0.0

build.gradle

@@ -7,7 +7,7 @@ plugins {
 }
 
 group 'dev.poire.buzz4j'
-version '1.0.0-SNAPSHOT'
+version '1.0.0'
 
 sourceCompatibility = 1.8
 targetCompatibility = 1.8

src/main/java/dev/poire/buzz4j/HarfBuzz.java

@@ -4,6 +4,9 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 
+/**
+ * Java bindings for HarfBuzz.
+ */
 public class HarfBuzz {
 
     private static final int GLYPH_LENGTH = 5;
@@ -20,6 +23,14 @@ public class HarfBuzz {
         System.loadLibrary("buzz4j");
     }
 
+    /**
+     * Apply text-shaping to an input string. The result is an array of glyphs, with their drawing dimensions.
+     *
+     * @param fontPath Path to the font
+     * @param text Input text
+     * @return Array of {@link ShapeGlyph} (glyph information returned by HarfBuzz)
+     * @throws IOException Invalid font file
+     */
     public static ShapeGlyph[] shapeString(Path fontPath, String text) throws IOException {
         if (fontPath == null || !Files.isRegularFile(fontPath))
             throw new IOException(String.format("Font path provided is not a file: %s", fontPath));

src/main/java/dev/poire/buzz4j/ShapeGlyph.java

@@ -2,45 +2,76 @@
 
 import java.util.Objects;
 
+/**
+ * Represents a glyph with drawing information returned from HarfBuzz.
+ */
 public final class ShapeGlyph {
     private final int glyphId;
     private final int advanceX;
     private final int advanceY;
     private final int offsetX;
     private final int offsetY;
 
-    public ShapeGlyph(int glyphId, int advanceX, int advanceY, int offsetX, int offsetY) {
+    ShapeGlyph(int glyphId, int advanceX, int advanceY, int offsetX, int offsetY) {
         this.glyphId = glyphId;
         this.advanceX = advanceX;
         this.advanceY = advanceY;
         this.offsetX = offsetX;
         this.offsetY = offsetY;
     }
 
+    /**
+     * The integer ID of the glpyh.
+     * @return the integer ID
+     */
     public int glyphId() {
         return glyphId;
     }
 
+    /**
+     * By how much the glyph advances the text shape on the X axis
+     * @return the advance on X axis
+     */
     public int advanceX() {
         return advanceX;
     }
 
+    /**
+     * By how much the glyph advances the text shape on the Y axis
+     * @return the advance on Y axis
+     */
     public int advanceY() {
         return advanceY;
     }
 
+    /**
+     * By how much the glyph should be offseted on the X axis
+     * @return the offset on X axis
+     */
     public int offsetX() {
         return offsetX;
     }
 
+    /**
+     * By how much the glyph should be offseted on the Y axis
+     * @return the offset on Y axis
+     */
     public int offsetY() {
         return offsetY;
     }
 
+    /**
+     * The effective width of the glyph.
+     * @return the sum of offset and advance
+     */
     public int effectiveWidth() {
         return advanceX + offsetX;
     }
 
+    /**
+     * The effective height of the glyph.
+     * @return the sum of offset and advance
+     */
     public int effectiveHeight() {
         return advanceY + offsetY;
     }