You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@poi.apache.org by kl...@apache.org on 2003/09/13 14:15:38 UTC
cvs commit: jakarta-poi/src/contrib/src/org/apache/poi/contrib/poibrowser Codec.java PropertySetDescriptor.java TreeReaderListener.java
klute 2003/09/13 05:15:38
Modified: src/contrib/src/org/apache/poi/contrib/poibrowser Codec.java
PropertySetDescriptor.java TreeReaderListener.java
Log:
Javadoc fixes
Revision Changes Path
1.5 +2 -2 jakarta-poi/src/contrib/src/org/apache/poi/contrib/poibrowser/Codec.java
Index: Codec.java
===================================================================
RCS file: /home/cvs/jakarta-poi/src/contrib/src/org/apache/poi/contrib/poibrowser/Codec.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- Codec.java 28 Jul 2003 16:56:45 -0000 1.4
+++ Codec.java 13 Sep 2003 12:15:38 -0000 1.5
@@ -214,7 +214,7 @@
*
* @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)
1.2 +2 -2 jakarta-poi/src/contrib/src/org/apache/poi/contrib/poibrowser/PropertySetDescriptor.java
Index: PropertySetDescriptor.java
===================================================================
RCS file: /home/cvs/jakarta-poi/src/contrib/src/org/apache/poi/contrib/poibrowser/PropertySetDescriptor.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- PropertySetDescriptor.java 14 Feb 2002 04:00:58 -0000 1.1
+++ PropertySetDescriptor.java 13 Sep 2003 12:15:38 -0000 1.2
@@ -96,7 +96,7 @@
*
* @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,
1.5 +26 -18 jakarta-poi/src/contrib/src/org/apache/poi/contrib/poibrowser/TreeReaderListener.java
Index: TreeReaderListener.java
===================================================================
RCS file: /home/cvs/jakarta-poi/src/contrib/src/org/apache/poi/contrib/poibrowser/TreeReaderListener.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- TreeReaderListener.java 4 Sep 2003 19:46:00 -0000 1.4
+++ TreeReaderListener.java 13 Sep 2003 12:15:38 -0000 1.5
@@ -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 @@
* 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"><klute@rainer-klute.de></a>
@@ -121,7 +128,8 @@
/**
* <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
---------------------------------------------------------------------
To unsubscribe, e-mail: poi-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: poi-dev-help@jakarta.apache.org