From: Nick Burch <nick@apache.org>
Date: Mon, 4 Jun 2007 18:22:18 +0000 (+0000)
Subject: Replace the single method JavaDoc copied from the JDK with our own documentation... 
X-Git-Tag: REL_3_0_1_RC2~3
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=96d95e6741b437f70afacd56b078a6b3d85e2083;p=poi.git

Replace the single method JavaDoc copied from the JDK with our own documentation, which is possibly also easier to grok

git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@544197 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/src/java/org/apache/poi/hssf/usermodel/EscherGraphics.java b/src/java/org/apache/poi/hssf/usermodel/EscherGraphics.java
index 90eef8b9bc..f13bd0ed1f 100644
--- a/src/java/org/apache/poi/hssf/usermodel/EscherGraphics.java
+++ b/src/java/org/apache/poi/hssf/usermodel/EscherGraphics.java
@@ -351,6 +351,25 @@ public class EscherGraphics
         shape.setLineStyleColor(foreground.getRed(), foreground.getGreen(), foreground.getBlue());
     }
 
+    /**
+     * Fills a (closed) polygon, as defined by a pair of arrays, which
+     *  hold the <i>x</i> and <i>y</i> coordinates.
+     * <p>
+     * This draws the polygon, with <code>nPoint</code> line segments.
+     * The first <code>nPoint&nbsp;-&nbsp;1</code> line segments are
+     *  drawn between sequential points 
+     *  (<code>xPoints[i],yPoints[i],xPoints[i+1],yPoints[i+1]</code>).
+     * The final line segment is a closing one, from the last point to 
+     *  the first (assuming they are different).
+     * <p>
+     * The area inside of the polygon is defined by using an
+     *  even-odd fill rule (also known as the alternating rule), and 
+     *  the area inside of it is filled.
+     * @param xPoints array of the <code>x</code> coordinates.
+     * @param yPoints array of the <code>y</code> coordinates.
+     * @param nPoints the total number of points in the polygon.
+     * @see   java.awt.Graphics#drawPolygon(int[], int[], int)
+     */
     public void fillPolygon(int xPoints[], int yPoints[],
 				     int nPoints)
     {
diff --git a/src/java/org/apache/poi/hssf/usermodel/EscherGraphics2d.java b/src/java/org/apache/poi/hssf/usermodel/EscherGraphics2d.java
index e6c36bc950..217f0eba5f 100644
--- a/src/java/org/apache/poi/hssf/usermodel/EscherGraphics2d.java
+++ b/src/java/org/apache/poi/hssf/usermodel/EscherGraphics2d.java
@@ -329,24 +329,23 @@ public class EscherGraphics2d extends Graphics2D
     }
 
     /**
-     * Fills a closed polygon defined by
-     * arrays of <i>x</i> and <i>y</i> coordinates.
+     * Fills a (closed) polygon, as defined by a pair of arrays, which
+     *  hold the <i>x</i> and <i>y</i> coordinates.
      * <p>
-     * This method draws the polygon defined by <code>nPoint</code> line
-     * segments, where the first <code>nPoint&nbsp;-&nbsp;1</code>
-     * line segments are line segments from
-     * <code>(xPoints[i&nbsp;-&nbsp;1],&nbsp;yPoints[i&nbsp;-&nbsp;1])</code>
-     * to <code>(xPoints[i],&nbsp;yPoints[i])</code>, for
-     * 1&nbsp;&le;&nbsp;<i>i</i>&nbsp;&le;&nbsp;<code>nPoints</code>.
-     * The figure is automatically closed by drawing a line connecting
-     * the final point to the first point, if those points are different.
+     * This draws the polygon, with <code>nPoint</code> line segments.
+     * The first <code>nPoint&nbsp;-&nbsp;1</code> line segments are
+     *  drawn between sequential points 
+     *  (<code>xPoints[i],yPoints[i],xPoints[i+1],yPoints[i+1]</code>).
+     * The final line segment is a closing one, from the last point to 
+     *  the first (assuming they are different).
      * <p>
-     * The area inside the polygon is defined using an
-     * even-odd fill rule, also known as the alternating rule.
-     * @param        xPoints   a an array of <code>x</code> coordinates.
-     * @param        yPoints   a an array of <code>y</code> coordinates.
-     * @param        nPoints   a the total number of points.
-     * @see          java.awt.Graphics#drawPolygon(int[], int[], int)
+     * The area inside of the polygon is defined by using an
+     *  even-odd fill rule (also known as the alternating rule), and 
+     *  the area inside of it is filled.
+     * @param xPoints array of the <code>x</code> coordinates.
+     * @param yPoints array of the <code>y</code> coordinates.
+     * @param nPoints the total number of points in the polygon.
+     * @see   java.awt.Graphics#drawPolygon(int[], int[], int)
      */
     public void fillPolygon(int xPoints[], int yPoints[], int nPoints)
     {