[FOray-commit] SF.net SVN: foray: [8762] trunk/foray
Modular XSL-FO Implementation for Java.
Status: Alpha
Brought to you by:
victormote
Menu
▾
▴
[FOray-commit] SF.net SVN: foray: [8762] trunk/foray
|
From: <vic...@us...> - 2007-02-26 14:49:41
|
Revision: 8762
http://svn.sourceforge.net/foray/?rev=8762&view=rev
Author: victormote
Date: 2007-02-26 06:49:40 -0800 (Mon, 26 Feb 2007)
Log Message:
-----------
Javadoc improvements.
Modified Paths:
--------------
trunk/foray/foray-render/src/java/org/foray/render/awt/AWTRenderer.java
trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/MessageException.java
trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/PreviewDialog.java
trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/UserMessage.java
trunk/foray/foray-render/src/java/org/foray/render/pcl/PCLRenderer.java
trunk/foray/foray-render/src/java/org/foray/render/ps/PSGraphics2D.java
trunk/foray/foray-render/src/java/org/foray/render/ps/RunLengthEncodeOutputStream.java
trunk/foray/scripts/checkstyle-suppressions.xml
Modified: trunk/foray/foray-render/src/java/org/foray/render/awt/AWTRenderer.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/awt/AWTRenderer.java 2007-02-26 14:19:27 UTC (rev 8761)
+++ trunk/foray/foray-render/src/java/org/foray/render/awt/AWTRenderer.java 2007-02-26 14:49:40 UTC (rev 8762)
@@ -129,11 +129,13 @@
/** The current font size in millipoints. */
private int currentFontSize;
- /**
- * The current colour's red, green and blue component
- */
+ /** The current color's red component. */
private float currentRed = 0;
+
+ /** The current color's green component. */
private float currentGreen = 0;
+
+ /** The current color's blue component. */
private float currentBlue = 0;
/**
@@ -941,6 +943,7 @@
}
/**
+ * Sets the page width.
* @param pageWidth The pageWidth to set.
*/
public void setPageWidth(final int pageWidth) {
@@ -948,6 +951,7 @@
}
/**
+ * Sets the page height.
* @param pageHeight The pageHeight to set.
*/
public void setPageHeight(final int pageHeight) {
Modified: trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/MessageException.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/MessageException.java 2007-02-26 14:19:27 UTC (rev 8761)
+++ trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/MessageException.java 2007-02-26 14:49:40 UTC (rev 8762)
@@ -41,27 +41,22 @@
*
*/
public class MessageException extends Exception {
+
+ /** Constant needed for serialization. */
static final long serialVersionUID = 680021191981719625L;
- /**
- * Angabe der auslösenden Exception, wie z.B. NullPointerException.
- * Dieses Feld ist optional.
- */
+ /** Cause of the exception (optional). */
private Exception exception;
- /**
- * ID der Meldung, die für diese Exception ausgegeben werden soll
- */
+ /** The message id. */
private String messageId;
- /**
- * Parameterliste zur Meldung
- */
+ /** Parameter list for the message. */
private String[] parameterList;
-
- // Konstruktoren
-
+ /**
+ * No-parameter constructor.
+ */
public MessageException() {
this("UNKNOWN_EXCEPTION");
}
Modified: trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/PreviewDialog.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/PreviewDialog.java 2007-02-26 14:19:27 UTC (rev 8761)
+++ trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/PreviewDialog.java 2007-02-26 14:49:40 UTC (rev 8762)
@@ -71,7 +71,7 @@
import javax.swing.SwingUtilities;
/**
- * Frame and User Interface for Preview
+ * Frame and User Interface for Preview.
*/
public class PreviewDialog extends JFrame implements ProgressListener {
@@ -457,7 +457,7 @@
}
/**
- * Show the About box
+ * Show the "About" box.
*
* @param e a value of type 'ActionEvent'
*/
@@ -473,7 +473,7 @@
}
/**
- * Change the current visible page
+ * Change the current visible page.
*
* @param number the page number to go to
*/
@@ -641,19 +641,16 @@
* a thread safe way.
*/
class ShowProgress implements Runnable {
- /**
- * The message to display
- */
+
+ /** The message to display. */
private Object message;
- /**
- * Is this an errorMessage, i.e. should it be shown in
- * an JOptionPane or in the status bar.
- */
+ /** Is this an errorMessage, i.e. should it be shown in an JOptionPane
+ * or in the status bar. */
private boolean isErrorMessage = false;
/**
- * Constructs showProgress thread
+ * Constructs a showProgress thread.
* @param message message to display
* @param isErrorMessage show in status bar or in JOptionPane
*/
@@ -690,9 +687,8 @@
class ShowPageImage implements Runnable {
/**
- * The run method that does the actuall updating
+ * {@inheritDoc}
*/
-
public void run() {
BufferedImage pageImage = null;
Graphics graphics = null;
Modified: trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/UserMessage.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/UserMessage.java 2007-02-26 14:19:27 UTC (rev 8761)
+++ trunk/foray/foray-render/src/java/org/foray/render/awt/viewer/UserMessage.java 2007-02-26 14:49:40 UTC (rev 8762)
@@ -68,49 +68,23 @@
*/
private static final int SYS_ERROR = JOptionPane.ERROR_MESSAGE;
-
-
- /*
- * Style Constanten orientieren sich auf die
- * Constanten der ButtonDialog-Klasse und legen das Dialog-ButtonSet fest.
- */
-
- /**
- * Wert für Setzten keines Buttons
- */
+ /** Style indicating no buttons. */
private static final int STYLE_NOBUTTON = -2;
- /**
- * Wert für Setzten von nur Ja-Button.
- */
+ /** Style indicating a "Yes" button. */
private static final int STYLE_Y = JOptionPane.DEFAULT_OPTION;
- // ButtonDialog.YES; // = 1
- /**
- * Wert für Setzten von Ja- und Nein-Buttons.
- */
+ /** Style indicating "Yes" and "No" buttons. */
private static final int STYLE_Y_N = JOptionPane.YES_NO_OPTION;
- // ButtonDialog.YES_NO; // = 2;
- /**
- * Wert für Setzten von Ja-, Nein-und Abbruch Buttons.
- */
+ /** Style indicating "Yes", "No", and "Cancel" buttons. */
private static final int STYLE_Y_N_C = JOptionPane.YES_NO_CANCEL_OPTION;
- // ButtonDialog.YES_NO_CANCEL; // = 3;
-
// Platzhalter für Parameter in der Properties-Datei
private static final String PARAMETER_TAG = "&&&";
-
- /**
- * Benutzer-Antwort-Constanten orientieren sich auf die
- * Constanten der ButtonDialog-Klasse
- */
-
// Default-Values
private static String actMessId = null;
- // private static MessagesDialog nobuttonDialog = null;
private Translator res = null;
private Log logger;
@@ -130,7 +104,7 @@
}
/**
- * Ersetzt die eventuellen Platzhalter durch die übergebenen Parameter
+ * Prepares the message using the parameters.
*/
String prepareMessage(final String rawText, final String[] par) {
logger.info("prepareMessage(): " + rawText + ", parameter: "
Modified: trunk/foray/foray-render/src/java/org/foray/render/pcl/PCLRenderer.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/pcl/PCLRenderer.java 2007-02-26 14:19:27 UTC (rev 8761)
+++ trunk/foray/foray-render/src/java/org/foray/render/pcl/PCLRenderer.java 2007-02-26 14:49:40 UTC (rev 8762)
@@ -252,7 +252,7 @@
}
/**
- * add a filled rectangle to the current stream
+ * Add a filled rectangle to the current stream.
*
* @param x the x position of left edge in millipoints
* @param y the y position of top edge in millipoints
Modified: trunk/foray/foray-render/src/java/org/foray/render/ps/PSGraphics2D.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/ps/PSGraphics2D.java 2007-02-26 14:19:27 UTC (rev 8761)
+++ trunk/foray/foray-render/src/java/org/foray/render/ps/PSGraphics2D.java 2007-02-26 14:49:40 UTC (rev 8762)
@@ -119,7 +119,7 @@
}
/**
- * This constructor supports the create method
+ * Constructor supporting the {@link #create()} method.
*/
public PSGraphics2D(final PSGraphics2D g) {
super(g);
Modified: trunk/foray/foray-render/src/java/org/foray/render/ps/RunLengthEncodeOutputStream.java
===================================================================
--- trunk/foray/foray-render/src/java/org/foray/render/ps/RunLengthEncodeOutputStream.java 2007-02-26 14:19:27 UTC (rev 8761)
+++ trunk/foray/foray-render/src/java/org/foray/render/ps/RunLengthEncodeOutputStream.java 2007-02-26 14:49:40 UTC (rev 8762)
@@ -72,6 +72,7 @@
/**
+ * Writes a byte.
* @see java.io.OutputStream#write(int)
* @param b the <code>byte</code>.
* @exception IOException if an I/O error occurs. In particular,
@@ -162,9 +163,7 @@
/**
- * @see java.io.OutputStream#write(byte[])
- * @param b the data.
- * @exception IOException if an I/O error occurs.
+ * {@inheritDoc}
*/
public void write(final byte[] b)
throws IOException {
@@ -176,13 +175,7 @@
/**
- * @see java.io.OutputStream#write(byte[], int, int)
- * @param b the data.
- * @param off the start offset in the data.
- * @param len the number of bytes to write.
- * @exception IOException if an I/O error occurs. In particular,
- * an <code>IOException</code> is thrown if the output
- * stream is closed.
+ * {@inheritDoc}
*/
public void write(final byte[] b, final int off, final int len)
throws IOException {
Modified: trunk/foray/scripts/checkstyle-suppressions.xml
===================================================================
--- trunk/foray/scripts/checkstyle-suppressions.xml 2007-02-26 14:19:27 UTC (rev 8761)
+++ trunk/foray/scripts/checkstyle-suppressions.xml 2007-02-26 14:49:40 UTC (rev 8762)
@@ -16,7 +16,7 @@
files="org.foray.pdf.*"/>
<suppress checks="Javadoc[MVS].*"
files="org.foray.pioneer.*"/>
- <suppress checks="Javadoc[MVS].*"
+ <suppress checks="Javadoc[MV].*"
files="org.foray.render.*"/>
<!-- Suppress Javadoc package documentation for test directories. -->
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
