added useful bit of doc

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@195087 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/org/apache/fop/layout/FontMetric.java b/src/org/apache/fop/layout/FontMetric.java
index 93b60ae928ff9957dbd3c08c1ec11a1a22785987..99c15b7f93a782a37a3b4872b56b24b3a96b9d81 100644 (file)
--- a/src/org/apache/fop/layout/FontMetric.java
+++ b/src/org/apache/fop/layout/FontMetric.java
@@ -25,5 +25,11 @@ public interface FontMetric {
      * code point i
      */
     public int width(int i, int size);
+
+    /**
+     * Return the array of widths.
+     * This is used to get an array for inserting in an output format.
+     * It should not be used for lookup.
+     */
     public int[] getWidths(int size);
 }