Author: nick
Date: Mon Jun 4 11:22:18 2007
New Revision: 544197
URL: http://svn.apache.org/viewvc?view=rev&rev=544197
Log:
Replace the single method JavaDoc copied from the JDK with our own
documentation, which is possibly also easier to grok
Modified:
jakarta/poi/trunk/src/java/org/apache/poi/hssf/usermodel/EscherGraphics.java
jakarta/poi/trunk/src/java/org/apache/poi/hssf/usermodel/EscherGraphics2d.java
Modified:
jakarta/poi/trunk/src/java/org/apache/poi/hssf/usermodel/EscherGraphics.java
URL:
http://svn.apache.org/viewvc/jakarta/poi/trunk/src/java/org/apache/poi/hssf/usermodel/EscherGraphics.java?view=diff&rev=544197&r1=544196&r2=544197
==============================================================================
---
jakarta/poi/trunk/src/java/org/apache/poi/hssf/usermodel/EscherGraphics.java
(original)
+++
jakarta/poi/trunk/src/java/org/apache/poi/hssf/usermodel/EscherGraphics.java
Mon Jun 4 11:22:18 2007
@@ -351,6 +351,25 @@
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 - 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)
{
Modified:
jakarta/poi/trunk/src/java/org/apache/poi/hssf/usermodel/EscherGraphics2d.java
URL:
http://svn.apache.org/viewvc/jakarta/poi/trunk/src/java/org/apache/poi/hssf/usermodel/EscherGraphics2d.java?view=diff&rev=544197&r1=544196&r2=544197
==============================================================================
---
jakarta/poi/trunk/src/java/org/apache/poi/hssf/usermodel/EscherGraphics2d.java
(original)
+++
jakarta/poi/trunk/src/java/org/apache/poi/hssf/usermodel/EscherGraphics2d.java
Mon Jun 4 11:22:18 2007
@@ -329,24 +329,23 @@
}
/**
- * 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 - 1</code>
- * line segments are line segments from
- * <code>(xPoints[i - 1], yPoints[i - 1])</code>
- * to <code>(xPoints[i], yPoints[i])</code>, for
- * 1 ≤ <i>i</i> ≤ <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 - 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)
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
