Fix FT_Face Javadoc

jwharm · Nov 5, 2023 · d6494b0 · d6494b0
1 parent 95d976b
commit d6494b0
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/main/java/org/freedesktop/freetype/Face.java b/src/main/java/org/freedesktop/freetype/Face.java
@@ -62,6 +62,9 @@ public Face(MemorySegment address) {
      * @param faceIndex    See <a href=
      *                     "https://freetype.org/freetype2/docs/reference/ft2-face_creation.html#ft_open_face">FT_Open_Face</a>
      *                     for a detailed description of this parameter.
+     * @return the newly created Face instance
+     * @throws UnsupportedOperationException when {@code FT_Init_FreeType} returns a
+     *                                       non-zero error code
      */
     public static Face newFace(Library library, String filepathname, long faceIndex) {
         Arena allocator = Arena.ofConfined();