moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

Javadoc fixes

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/jakarta/poi/trunk@353346 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Rainer Klute 2003-09-13 12:15:38 +00:00
parent f1182ce38a
commit 825df755ba
3 changed files with 27 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/contrib/src/org/apache/poi/contrib/poibrowser/Codec.java
View File

@ -214,7 +214,7 @@ public class Codec
* *
* @return The bytes * @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. * a valid representation of a byte sequence.
*/ */
public static byte[] hexDecode(final String s) public static byte[] hexDecode(final String s)

2
src/contrib/src/org/apache/poi/contrib/poibrowser/PropertySetDescriptor.java
View File

@ -96,7 +96,7 @@ public class PropertySetDescriptor extends DocumentDescriptor
* *
* @param stream The stream. * @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. * dump starting at the beginning of the stream.
*/ */
public PropertySetDescriptor(final String name, public PropertySetDescriptor(final String name,

40
src/contrib/src/org/apache/poi/contrib/poibrowser/TreeReaderListener.java
View File

@ -58,26 +58,32 @@
package org.apache.poi.contrib.poibrowser; package org.apache.poi.contrib.poibrowser;
import java.io.*; import java.io.IOException;
import java.util.*; import java.util.HashMap;
import javax.swing.tree.*; import java.util.Map;
import org.apache.poi.hpsf.*;
import org.apache.poi.poifs.eventfilesystem.*; import javax.swing.tree.DefaultMutableTreeNode;
import org.apache.poi.poifs.filesystem.*; 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 * <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 * e.g. displayed in a Swing {@link javax.swing.JTree}. An instance of this
* is created with a root tree node ({@link MutableTreeNode}) and * class is created with a root tree node ({@link MutableTreeNode}) and
* registered as a {@link POIFSReaderListener} with a {@link * registered as a {@link POIFSReaderListener} with a {@link
* POIFSReader}. While the latter processes a POI filesystem it calls * org.apache.poi.poifs.eventfilesystem.POIFSReader}. While the latter processes
* this class' {@link #processPOIFSReaderEvent} for each document it * a POI filesystem it calls this class' {@link #processPOIFSReaderEvent} for
* has been registered for. This method appends the document it * each document it has been registered for. This method appends the document it
* processes at the appropriate position into the tree rooted at the * processes at the appropriate position into the tree rooted at the
* above mentioned root tree node.</p> * above mentioned root tree node.</p>
* *
* <p>The root tree node should be the root tree node of a {@link * <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 * <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 * 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> * but it could be any other string.</p>
* *
* <p>The value of a tree node is a {@link DocumentDescriptor}. Unlike * <p>The value of a tree node is a {@link DocumentDescriptor}. Unlike
* a {@link POIFSDocument} which may be as heavy as many megabytes, an * a {@link org.apache.poi.poifs.filesystem.POIFSDocument} which may be as heavy
* instance of {@link DocumentDescriptor} is a light-weight object and * as many megabytes, an instance of {@link DocumentDescriptor} is a
* contains only some meta-information about a document.</p> * light-weight object and contains only some meta-information about a
* document.</p>
* *
* @author Rainer Klute <a * @author Rainer Klute <a
* href="mailto:klute@rainer-klute.de">&lt;klute@rainer-klute.de&gt;</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 * <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 * @param filename The name of the POI filesystem, i.e. the name
* of the file the POI filesystem resides in. Alternatively any * of the file the POI filesystem resides in. Alternatively any