Javadoc fixes

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

3 files changed, 14 insertions, 14 deletions

diff --git a/src/java/org/apache/poi/hssf/eventmodel/HSSFEventFactory.java b/src/java/org/apache/poi/hssf/eventmodel/HSSFEventFactory.java
index b415f3b54f..2609c8c76b 100644
--- a/src/java/org/apache/poi/hssf/eventmodel/HSSFEventFactory.java
+++ b/src/java/org/apache/poi/hssf/eventmodel/HSSFEventFactory.java
@@ -91,8 +91,8 @@ public class HSSFEventFactory
     /**
      * Processes a file into essentially record events.
      *
-     * @param request an Instance of HSSFRequest which has your registered listeners
-     * @param filesystem a POIFS filesystem containing your workbook
+     * @param req       an Instance of HSSFRequest which has your registered listeners
+     * @param fs        a POIFS filesystem containing your workbook
      */
 
     public void processWorkbookEvents(HSSFRequest req, POIFSFileSystem fs)
@@ -107,8 +107,8 @@ public class HSSFEventFactory
      * Processes a DocumentInputStream into essentially Record events.
      *
      * @see org.apache.poi.poifs.filesystem.POIFSFileSystem#createDocumentInputStream(String)
-     * @param request an Instance of HSSFRequest which has your registered listeners
-     * @param InputStream - a DocumentInputStream obtained from POIFS's POIFSFileSystem object
+     * @param req       an Instance of HSSFRequest which has your registered listeners
+     * @param in        a DocumentInputStream obtained from POIFS's POIFSFileSystem object
      */
 
     public void processEvents(HSSFRequest req, InputStream in)
diff --git a/src/java/org/apache/poi/hssf/eventmodel/HSSFRequest.java b/src/java/org/apache/poi/hssf/eventmodel/HSSFRequest.java
index d2bd8fda7b..5c207e6e6f 100644
--- a/src/java/org/apache/poi/hssf/eventmodel/HSSFRequest.java
+++ b/src/java/org/apache/poi/hssf/eventmodel/HSSFRequest.java
@@ -93,8 +93,8 @@ public class HSSFRequest
      *
      * @see #addListenerForAllRecords(HSSFListener)
      *
-     * @param listener for the event
-     * @param static identifier for the record type this is the .sid static member on the individual records
+     * @param lsnr      for the event
+     * @param sid       identifier for the record type this is the .sid static member on the individual records
      *        for example req.addListener(myListener, BOFRecord.sid)
      */
 
@@ -124,7 +124,7 @@ public class HSSFRequest
      * compelling reason to do so (like maybe you send the event two places or log it or
      * something?).
      *
-     * @param a single listener to associate with ALL records
+     * @param lsnr      a single listener to associate with ALL records
      */
 
     public void addListenerForAllRecords(HSSFListener lsnr)
diff --git a/src/java/org/apache/poi/hssf/model/Workbook.java b/src/java/org/apache/poi/hssf/model/Workbook.java
index e839f0d830..8329a1f00b 100644
--- a/src/java/org/apache/poi/hssf/model/Workbook.java
+++ b/src/java/org/apache/poi/hssf/model/Workbook.java
@@ -134,7 +134,7 @@ public class Workbook
 
     /**
      * Creates new Workbook with no intitialization --useless right now
-     * @see #createWorkbook(Record[])
+     * @see #createWorkbook(List)
      */
 
     public Workbook()
@@ -353,7 +353,7 @@ public class Workbook
     /**
      * gets the number of font records
      *
-     * @param number of font records in the "font table"
+     * @return   number of font records in the "font table"
      */
 
     public int getNumberOfFontRecords()
@@ -644,7 +644,7 @@ public class Workbook
         log.log(DEBUG, "Serializing Workbook with offsets");
 
         // ArrayList bytes     = new ArrayList(records.size());
-        int arraysize = getSize();   // 0;
+//        int arraysize = getSize();   // 0;
         int pos       = 0;
 
 //        for (int k = 0; k < records.size(); k++)
@@ -1056,7 +1056,7 @@ public class Workbook
 
     /**
      * Creates a FormatRecord object
-     * @param the number of the format record to create (meaning its position in
+     * @param id    the number of the format record to create (meaning its position in
      *        a file as M$ Excel would create it.)
      * @return record containing a FormatRecord
      * @see org.apache.poi.hssf.record.FormatRecord
@@ -1128,7 +1128,7 @@ public class Workbook
 
     /**
      * Creates an ExtendedFormatRecord object
-     * @param the number of the extended format record to create (meaning its position in
+     * @param id    the number of the extended format record to create (meaning its position in
      *        a file as MS Excel would create it.)
      *
      * @return record containing an ExtendedFormatRecord
@@ -1484,8 +1484,8 @@ public class Workbook
 
     /**
      * Creates a StyleRecord object
-     * @param the number of the style record to create (meaning its position in
-     *        a file as MS Excel would create it.
+     * @param id        the number of the style record to create (meaning its position in
+     *                  a file as MS Excel would create it.
      * @return record containing a StyleRecord
      * @see org.apache.poi.hssf.record.StyleRecord
      * @see org.apache.poi.hssf.record.Record