Javadoc fixes

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

diff --git a/src/contrib/src/org/apache/poi/contrib/poibrowser/Codec.java b/src/contrib/src/org/apache/poi/contrib/poibrowser/Codec.java
index 7f5c2508e0b4defbfd782ee697181de1d476b4d1..459e23ad364278026381e1b3a90cc2b85f30eeb6 100644 (file)
--- a/src/contrib/src/org/apache/poi/contrib/poibrowser/Codec.java
+++ b/src/contrib/src/org/apache/poi/contrib/poibrowser/Codec.java
@@ -214,7 +214,7 @@ public class Codec
      *
      * @return The bytes
      *
-     * @throw IllegalArgumentException if the string does not contain
+     * @throws IllegalArgumentException if the string does not contain
      * a valid representation of a byte sequence.
      */
     public static byte[] hexDecode(final String s)

diff --git a/src/contrib/src/org/apache/poi/contrib/poibrowser/PropertySetDescriptor.java b/src/contrib/src/org/apache/poi/contrib/poibrowser/PropertySetDescriptor.java
index 2d38d4717c5cfd3bf265492d3fbe9968d61fab55..30b71fa748609feca040c292f6b8124312fa636b 100644 (file)
--- a/src/contrib/src/org/apache/poi/contrib/poibrowser/PropertySetDescriptor.java
+++ b/src/contrib/src/org/apache/poi/contrib/poibrowser/PropertySetDescriptor.java
@@ -96,7 +96,7 @@ public class PropertySetDescriptor extends DocumentDescriptor
      *
      * @param stream The stream.
      *
-     * @param nrOfBytes The maximum number of bytes to display in a
+     * @param nrOfBytesToDump The maximum number of bytes to display in a
      * dump starting at the beginning of the stream.
      */
     public PropertySetDescriptor(final String name,

diff --git a/src/contrib/src/org/apache/poi/contrib/poibrowser/TreeReaderListener.java b/src/contrib/src/org/apache/poi/contrib/poibrowser/TreeReaderListener.java
index a8d1edfcd24015ece24490cd832eb2b002df9da1..558e408383dbcb10262812c4493cac60ca915536 100644 (file)
--- a/src/contrib/src/org/apache/poi/contrib/poibrowser/TreeReaderListener.java
+++ b/src/contrib/src/org/apache/poi/contrib/poibrowser/TreeReaderListener.java
@@ -58,26 +58,32 @@
 
 package org.apache.poi.contrib.poibrowser;
 
-import java.io.*;
-import java.util.*;
-import javax.swing.tree.*;
-import org.apache.poi.hpsf.*;
-import org.apache.poi.poifs.eventfilesystem.*;
-import org.apache.poi.poifs.filesystem.*;
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+
+import javax.swing.tree.DefaultMutableTreeNode;
+import javax.swing.tree.MutableTreeNode;
+
+import org.apache.poi.hpsf.HPSFException;
+import org.apache.poi.poifs.eventfilesystem.POIFSReaderEvent;
+import org.apache.poi.poifs.eventfilesystem.POIFSReaderListener;
+import org.apache.poi.poifs.filesystem.DocumentInputStream;
+import org.apache.poi.poifs.filesystem.POIFSDocumentPath;
 
 /**
  * <p>Organizes document information in a tree model in order to be
- * e.g. displayed in a Swing {@link JTree}. An instance of this class
- * is created with a root tree node ({@link MutableTreeNode}) and
- * registered as a {@link POIFSReaderListener} with a {@link
- * POIFSReader}. While the latter processes a POI filesystem it calls
- * this class' {@link #processPOIFSReaderEvent} for each document it
- * has been registered for. This method appends the document it
+ * e.g. displayed in a Swing {@link javax.swing.JTree}. An instance of this
+ * class is created with a root tree node ({@link MutableTreeNode}) and
+ * registered as a {@link POIFSReaderListener} with a {@link 
+ * org.apache.poi.poifs.eventfilesystem.POIFSReader}. While the latter processes
+ * a POI filesystem it calls this class' {@link #processPOIFSReaderEvent} for
+ * each document it has been registered for. This method appends the document it
  * processes at the appropriate position into the tree rooted at the
  * above mentioned root tree node.</p>
  *
  * <p>The root tree node should be the root tree node of a {@link
- * TreeModel}.</p>
+ * javax.swing.tree.TreeModel}.</p>
  *
  * <p>A top-level element in the tree model, i.e. an immediate child
  * node of the root node, describes a POI filesystem as such. It is
@@ -85,9 +91,10 @@ import org.apache.poi.poifs.filesystem.*;
  * but it could be any other string.</p>
  *
  * <p>The value of a tree node is a {@link DocumentDescriptor}. Unlike
- * a {@link POIFSDocument} which may be as heavy as many megabytes, an
- * instance of {@link DocumentDescriptor} is a light-weight object and
- * contains only some meta-information about a document.</p>
+ * a {@link org.apache.poi.poifs.filesystem.POIFSDocument} which may be as heavy
+ * as many megabytes, an instance of {@link DocumentDescriptor} is a
+ * light-weight object and contains only some meta-information about a
+ * document.</p>
  *
  * @author Rainer Klute <a
  * href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</a>
@@ -121,7 +128,8 @@ public class TreeReaderListener implements POIFSReaderListener
 
     /**
      * <p>Creates a {@link TreeReaderListener} which should then be
-     * registered with a {@link POIFSReader}.</p>
+     * registered with a
+     * {@link org.apache.poi.poifs.eventfilesystem.POIFSReader}.</p>
      *
      * @param filename The name of the POI filesystem, i.e. the name
      * of the file the POI filesystem resides in. Alternatively any