Cleanup various javadoc issues.

Collect several javadoc issues from Noel:

Fix a bunch of javadoc warnings in param.
Cleanup javadoc see tags.
Fix various misc. javadoc issues.

Author:	Noel Grandin

17 files changed, 19 insertions, 33 deletions

diff --git a/xmerge/source/aportisdoc/java/org/openoffice/xmerge/converter/xml/sxw/aportisdoc/DocDecoder.java b/xmerge/source/aportisdoc/java/org/openoffice/xmerge/converter/xml/sxw/aportisdoc/DocDecoder.java
index cd6fbdef8ef7..b6b4af79497e 100644
--- a/xmerge/source/aportisdoc/java/org/openoffice/xmerge/converter/xml/sxw/aportisdoc/DocDecoder.java
+++ b/xmerge/source/aportisdoc/java/org/openoffice/xmerge/converter/xml/sxw/aportisdoc/DocDecoder.java
@@ -32,8 +32,7 @@ import org.openoffice.xmerge.util.Resources;
 import org.openoffice.xmerge.util.Debug;
 
 /**
- *  This class is used by {@link
- *  org.openoffice.xmerge.converter.xml.sxw.DocumentDeserializerImpl}
+ *  This class is used by {@link DocumentDeserializerImpl}
  *  to decode the AportisDoc format.  It currently decodes
  *  the text content into a single <code>String</code> object.
  *
@@ -61,7 +60,7 @@ final class DocDecoder implements DocConstants {
      *  Decode the text records into a single <code>String</code>
      *  of text content.
      *
-     *  @param  Record  <code>Record</code> array holding AportisDoc
+     *  @param  recs  <code>Record</code> array holding AportisDoc
      *                  contents.
      *
      *  @throws  IOException  If any I/O error occurs.
@@ -119,7 +118,7 @@ final class DocDecoder implements DocConstants {
      *  with the encoding of that PDB and throw
      *  <code>IOException</code>.</p>
      *
-     *  @param  bytes           Compressed <code>byte</code> array.
+     *  @param  cBytes           Compressed <code>byte</code> array.
      *  @param  textRecordSize  Size of uncompressed
      *                          <code>byte</code> array.
      *
diff --git a/xmerge/source/aportisdoc/java/org/openoffice/xmerge/converter/xml/sxw/aportisdoc/DocEncoder.java b/xmerge/source/aportisdoc/java/org/openoffice/xmerge/converter/xml/sxw/aportisdoc/DocEncoder.java
index 2063b2f3286b..59a10d78cc51 100644
--- a/xmerge/source/aportisdoc/java/org/openoffice/xmerge/converter/xml/sxw/aportisdoc/DocEncoder.java
+++ b/xmerge/source/aportisdoc/java/org/openoffice/xmerge/converter/xml/sxw/aportisdoc/DocEncoder.java
@@ -32,9 +32,7 @@ import java.util.ArrayList;
 import org.openoffice.xmerge.converter.palm.Record;
 
 /**
- *  This class is used by {@link
- *  org.openoffice.xmerge.converter.xml.sxw.DocumentSerializerImpl
- *  DocumentSerializerImpl} to encode the AportisDoc format.
+ *  This class is used by {@link DocumentSerializerImpl} to encode the AportisDoc format.
  *  It does not deal with any XML tags.  It only knows how to encode
  *  from <code>String</code>.
  *
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/PocketExcelDecoder.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/PocketExcelDecoder.java
index 0d3fd11b6e75..9c37b5642f45 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/PocketExcelDecoder.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/PocketExcelDecoder.java
@@ -39,8 +39,7 @@ import org.openoffice.xmerge.converter.xml.sxc.ColumnRowInfo;
 import org.openoffice.xmerge.converter.xml.sxc.pexcel.records.*;
 
 /**
- *  This class is used by {@link
- *  org.openoffice.xmerge.converter.xml.sxc.SxcDocumentDeserializerImpl}
+ *  This class is used by {@link SxcDocumentDeserializerImpl}
  *  SxcDocumentDeserializerImpl} to decode the Pocket Excel format.
  *
  *  @author   Paul Rank
@@ -78,7 +77,7 @@ final class PocketExcelDecoder extends SpreadsheetDecoder {
      *  converts it into a PocketWord WorkSheet.  The WorkSheet is then
      *  added to the WorkBook.
      *
-     *  @param  InputStream An <code>ConvertData</code> containing a
+     *  @param  cd An <code>ConvertData</code> containing a
      *                      Pocket Excel WorkSheet.
      *
      *  @throws  IOException  If any I/O error occurs.
diff --git a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/PocketExcelEncoder.java b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/PocketExcelEncoder.java
index b64de7dd1622..00b436d0b456 100644
--- a/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/PocketExcelEncoder.java
+++ b/xmerge/source/pexcel/java/org/openoffice/xmerge/converter/xml/sxc/pexcel/PocketExcelEncoder.java
@@ -35,9 +35,7 @@ import org.openoffice.xmerge.converter.xml.sxc.NameDefinition;
 import org.openoffice.xmerge.converter.xml.sxc.pexcel.records.Workbook;
 
 /**
- *  This class is used by {@link
- *  org.openoffice.xmerge.converter.xml.sxc.SxcDocumentSerializerImpl
- * SxcDocumentSerializerImpl} to encode the Pocket Excel format.
+ *  This class is used by {@link SxcDocumentSerializerImpl} to encode the Pocket Excel format.
  *
  *  @author  Martin Maher
  */
diff --git a/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/DocumentDeserializerImpl.java b/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/DocumentDeserializerImpl.java
index 77e87609ec48..b45d8a38891f 100644
--- a/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/DocumentDeserializerImpl.java
+++ b/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/DocumentDeserializerImpl.java
@@ -134,8 +134,6 @@ public final class DocumentDeserializerImpl
      *
      * @param   data    An Enumeration of all Paragraphs in the Pocket Word doc.
      *
-     * @return  The OpenOffice Writer XML representation of the data.
-     *
      * @throws  IOException     If any I/O errors occur.
      */
     private void buildDocument(Enumeration data) throws IOException {
diff --git a/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/ParagraphTextSegment.java b/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/ParagraphTextSegment.java
index e381def60230..313449a05ce0 100644
--- a/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/ParagraphTextSegment.java
+++ b/xmerge/source/pocketword/java/org/openoffice/xmerge/converter/xml/sxw/pocketword/ParagraphTextSegment.java
@@ -80,7 +80,7 @@ class ParagraphTextSegment implements PocketWordConstants {
     /**
      * <p>Sets the style for this segment.</p>
      *
-     * @param   data    The style describing this segment.
+     * @param   style    The style describing this segment.
      */
     public void setStyle (TextStyle style) {
         pStyle = style;
diff --git a/xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/DocumentDeserializerImpl.java b/xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/DocumentDeserializerImpl.java
index aede3c0a5886..03c5ecea3c4c 100644
--- a/xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/DocumentDeserializerImpl.java
+++ b/xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/DocumentDeserializerImpl.java
@@ -287,7 +287,7 @@ implements DOCConstants, OfficeConstants, DocumentDeserializer {
      *  <code>SXWDocument</code>.
      *
      *  @param  docName  <code>Document</code> name
-     *  @param  str      Text content of WordSmith format
+     *  @param  data      Text content of WordSmith format
      *
      *  @return  Resulting <code>SXWDocument</code> object.
      *
diff --git a/xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/DocumentSerializerImpl.java b/xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/DocumentSerializerImpl.java
index b6ba1fbe0eb2..8f50075d67aa 100644
--- a/xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/DocumentSerializerImpl.java
+++ b/xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/DocumentSerializerImpl.java
@@ -462,7 +462,7 @@ implements OfficeConstants, DocumentSerializer {
      *  <i>text:h</i>, <i>text:unordered-list</i> and
      *  <i>text:ordered-list</i>.
      *
-     *  @param  Node  <code>Node</code> to traverse.
+     *  @param  node  <code>Node</code> to traverse.
      *
      *  @throws  IOException  If any I/O error occurs.
      */
diff --git a/xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/PluginFactoryImpl.java b/xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/PluginFactoryImpl.java
index daf261dc3ffb..202149ad86ce 100644
--- a/xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/PluginFactoryImpl.java
+++ b/xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/PluginFactoryImpl.java
@@ -131,8 +131,6 @@ public final class PluginFactoryImpl extends SxwPluginFactory
      *  which is an implementation of the <code>DocumentMerger</code>
      *  interface.
      *
-     *  @param  doc  <code>Document</code> to merge.
-     *
      *  @return  A Device Document object
      */
     public Document createDeviceDocument(String name, InputStream is)
diff --git a/xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/WSDecoder.java b/xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/WSDecoder.java
index 34c8c222386b..acedf849e2ff 100644
--- a/xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/WSDecoder.java
+++ b/xmerge/source/wordsmith/java/org/openoffice/xmerge/converter/xml/sxw/wordsmith/WSDecoder.java
@@ -61,7 +61,7 @@ final class WSDecoder implements DOCConstants {
     /**
      *  Decode the text records into a single <code>byte</code> array.
      *
-     *  @param  Record  <code>Record</code> array holding WordSmith
+     *  @param  recs  <code>Record</code> array holding WordSmith
      *                  contents.
      *
      *  @throws  IOException  If any I/O error occurs.
@@ -118,7 +118,7 @@ final class WSDecoder implements DOCConstants {
     /**
      *  Decode the text records into a <code>Wse</code> array.
      *
-     *  @param  Record[]  <code>Record</code> array holding DOC
+     *  @param  recs  <code>Record</code> array holding DOC
      *                    contents.
      *
      *  @throws  IOException  If any I/O error occurs.
@@ -178,7 +178,7 @@ final class WSDecoder implements DOCConstants {
      *  it as a problem with the encoding of that PDB and
      *  throw <code>IOException</code>.</p>
      *
-     *  @param  bytes           Compressed <code>byte</code> array
+     *  @param  cBytes           Compressed <code>byte</code> array
      *  @param  textRecordSize  Size of uncompressed <code>byte</code>
      *                          array
      *
diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/DOMDocument.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/DOMDocument.java
index f2cf7d3206ad..9c23e0cf9401 100644
--- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/DOMDocument.java
+++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/dom/DOMDocument.java
@@ -235,7 +235,7 @@ public class DOMDocument
      *  <p>TODO: remove dependency on com.sun.xml.tree.XmlDocument
      *  package!</p>
      *
-     *  @param  Document  DOM <code>Document</code> object.
+     *  @param  doc  DOM <code>Document</code> object.
      *
      *  @return  <code>byte</code> array of DOM <code>Document</code>
      *           object.
diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbHeader.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbHeader.java
index e8c91e50b823..53cef4f44380 100644
--- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbHeader.java
+++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/palm/PdbHeader.java
@@ -106,7 +106,7 @@ final class PdbHeader {
      *  Read in the data for the PDB header.  Need to
      *  preserve the unsigned value for some of the fields.
      *
-     *  @param  di  A <code>DataInput</code> object.
+     *  @param  in  A <code>DataInput</code> object.
      *
      *  @throws  IOException  If any I/O error occurs.
      */
diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/EmbeddedBinaryObject.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/EmbeddedBinaryObject.java
index 10711d345256..dfbf566eba25 100644
--- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/EmbeddedBinaryObject.java
+++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/EmbeddedBinaryObject.java
@@ -107,8 +107,6 @@ public class EmbeddedBinaryObject extends EmbeddedObject {
     /**
      * Package private method that constructs the manifest.xml entries for this
      * embedded object.
-     *
-     * @return  Document    <code>Document</code> containing the manifest entries.
      */
     void writeManifestData(Document manifestDoc) throws DOMException {
         Element objNode = manifestDoc.createElement(OfficeConstants.TAG_MANIFEST_FILE);
diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/EmbeddedObject.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/EmbeddedObject.java
index d44ebe4ea968..ea7424ff590c 100644
--- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/EmbeddedObject.java
+++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/EmbeddedObject.java
@@ -105,8 +105,6 @@ public abstract class EmbeddedObject {
     /**
      * Package private method that constructs the manifest.xml entries for this
      * embedded object.
-     *
-     * @return  Document    <code>Document</code> containing the manifest entries.
      */
     abstract void writeManifestData(Document manifestDoc) throws DOMException;
-}
\ No newline at end of file
+}
diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/OfficeDocument.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/OfficeDocument.java
index 3193bb7bd698..b68402c69ec5 100644
--- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/OfficeDocument.java
+++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/OfficeDocument.java
@@ -843,7 +843,7 @@ public abstract class OfficeDocument
      *  <p>TODO: remove dependency on com.sun.xml.tree.XmlDocument
      *  package!</p>
      *
-     *  @param  Document  DOM <code>Document</code> object.
+     *  @param  doc  DOM <code>Document</code> object.
      *
      *  @return  <code>byte</code> array of DOM <code>Document</code>
      *           object.
diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/OfficeZip.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/OfficeZip.java
index 803f1f054355..cb61a5b4145f 100644
--- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/OfficeZip.java
+++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/OfficeZip.java
@@ -39,7 +39,7 @@ import org.openoffice.xmerge.util.Debug;
 
 /**
  *  Class used by {@link
- *  org.openoffice.xmerge.converter.OfficeDocument
+ *  org.openoffice.xmerge.converter.xml.OfficeDocument
  *  OfficeDocument} to handle reading and writing
  *  from a ZIP file, as well as storing ZIP entries.
  *
diff --git a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/TextStyle.java b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/TextStyle.java
index cc67a3e15858..051a64d6864e 100644
--- a/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/TextStyle.java
+++ b/xmerge/source/xmerge/java/org/openoffice/xmerge/converter/xml/TextStyle.java
@@ -446,7 +446,7 @@ public class TextStyle extends Style implements Cloneable {
      *  Private function to return the value as an element in
      *  a Comma Separated Value (CSV) format.
      *
-     *  @param  The value to format.
+     *  @param  value The value to format.
      *
      *  @return  The formatted value.
      */