[FOray-commit] SF.net SVN: foray: [8763] trunk/foray

[<vic...@us...>]

Revision: 8763
          http://svn.sourceforge.net/foray/?rev=8763&view=rev
Author:   victormote
Date:     2007-02-26 07:05:51 -0800 (Mon, 26 Feb 2007)

Log Message:
-----------
Javadoc improvements.

Modified Paths:
--------------
    trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java
    trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java
    trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java
    trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FOTextPL.java
    trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java
    trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowCellArray.java
    trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableRowPL.java
    trunk/foray/scripts/checkstyle-suppressions.xml

Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java	2007-02-26 14:49:40 UTC (rev 8762)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/AbstractFlowPL.java	2007-02-26 15:05:51 UTC (rev 8763)
@@ -63,13 +63,15 @@
     }
 
    /**
-    * @param status The _status to set.
+    * Sets the status.
+    * @param status The status to set.
     */
     public void setStatus(final int status) {
         this.status = status;
     }
 
     /**
+     * Returns the progress snapshot.
      * @return Returns the progressSnapshot.
      */
     public List<Integer> getProgressSnapshot() {
@@ -77,6 +79,7 @@
     }
 
     /**
+     * Saves a progress snapshot.
      * @param progressSnapshot The progressSnapshot to be saved.
      */
     public void setProgressSnapshot(final List<Integer> progressSnapshot) {

Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java	2007-02-26 14:49:40 UTC (rev 8762)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/BlockPL.java	2007-02-26 15:05:51 UTC (rev 8763)
@@ -183,6 +183,7 @@
     }
 
     /**
+     * Set the current line area.
      * @param currentLineArea The currentLineArea to set.
      */
     public void setCurrentLineArea(final LineArea currentLineArea) {

Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java	2007-02-26 14:49:40 UTC (rev 8762)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FONodePL.java	2007-02-26 15:05:51 UTC (rev 8763)
@@ -105,6 +105,7 @@
     }
 
     /**
+     * Returns the progress value for this node.
      * @return Returns the progress value.
      */
     public int getProgress() {
@@ -152,6 +153,7 @@
     }
 
     /**
+     * Adds a text item to the line.
      * @return The index into the text (char []) to the first character that
      * was <em>not</em> successfully added to the line.
      */
@@ -182,6 +184,7 @@
     }
 
     /**
+     * Adds a non-text item to the line.
      * @return For non-text items, returns 1 for success or 0 if the item did
      * not fit onto the current line.
      */
@@ -270,6 +273,7 @@
     public abstract FONode getFONode();
 
     /**
+     * Returns the layout strategy.
      * @return Returns the layout.
      */
     public PioneerLS getLayout() {

Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FOTextPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FOTextPL.java	2007-02-26 14:49:40 UTC (rev 8762)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/FOTextPL.java	2007-02-26 15:05:51 UTC (rev 8763)
@@ -68,6 +68,7 @@
     }
 
     /**
+     * Adds text from this text item.
      * @return The index into the text char array that indicates the next array
      * element that should be laid out, or -1 if all of the text was succesfully
      * laid out. If the first six characters have been laid out (indices 0-5),

Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java	2007-02-26 14:49:40 UTC (rev 8762)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/PioneerLS.java	2007-02-26 15:05:51 UTC (rev 8763)
@@ -126,6 +126,7 @@
  * <li>A new page is created.</li>
  * <li>Using the status markers as guides, layout control is returned to the
  * place where it previously left off.</li>
+ * </ul>
  */
 public class PioneerLS extends LayoutStrategy implements ProxyFactory {
 
@@ -152,7 +153,7 @@
     }
 
     /**
-     * Runs the formatting of this page sequence into the given area tree
+     * Runs the formatting of this page sequence into the given area tree.
      */
     public void processPageSequence(final PageCollection pageCollection)
             throws AreaWException {

Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowCellArray.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowCellArray.java	2007-02-26 14:49:40 UTC (rev 8762)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/RowCellArray.java	2007-02-26 15:05:51 UTC (rev 8763)
@@ -73,7 +73,7 @@
 
 
     /**
-     * Return type of cell in colNum (1 based)
+     * Return type of cell in colNum (1 based).
      */
     public int getCellType(final int colNum) {
         if (colNum > 0 && colNum <= cells.length) {
@@ -83,7 +83,7 @@
     }
 
     /**
-     * Return cell in colNum (1 based)
+     * Return cell in colNum (1 based).
      */
     public TableCell getCell(final int colNum) {
         if (colNum > 0 && colNum <= cells.length) {
@@ -93,7 +93,7 @@
     }
 
     /**
-     * Store cell starting at cellColNum (1 based) and spanning numCols
+     * Store cell starting at cellColNum (1 based) and spanning numCols.
      * If any of the columns is already occupied, return false, else true
      */
     public boolean storeCell(final TableCell cell, final int colNum,

Modified: trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableRowPL.java
===================================================================
--- trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableRowPL.java	2007-02-26 14:49:40 UTC (rev 8762)
+++ trunk/foray/foray-pioneer/src/java/org/foray/pioneer/TableRowPL.java	2007-02-26 15:05:51 UTC (rev 8763)
@@ -289,6 +289,7 @@
     }
 
     /**
+     * Sets the ignore keep-together value.
      * @param ignoreKeepTogether The bIgnoreKeepTogether to set.
      */
     public void setBIgnoreKeepTogether(final boolean ignoreKeepTogether) {

Modified: trunk/foray/scripts/checkstyle-suppressions.xml
===================================================================
--- trunk/foray/scripts/checkstyle-suppressions.xml	2007-02-26 14:49:40 UTC (rev 8762)
+++ trunk/foray/scripts/checkstyle-suppressions.xml	2007-02-26 15:05:51 UTC (rev 8763)
@@ -14,7 +14,7 @@
       files="org.foray.fotree.*"/>
   <suppress checks="Javadoc[MVS].*"
       files="org.foray.pdf.*"/>
-  <suppress checks="Javadoc[MVS].*"
+  <suppress checks="Javadoc[MV].*"
       files="org.foray.pioneer.*"/>
   <suppress checks="Javadoc[MV].*"
       files="org.foray.render.*"/>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.