From: Rainer Klute <klute@apache.org>
Date: Fri, 3 Feb 2006 19:08:14 +0000 (+0000)
Subject: Minor API doc changes
X-Git-Tag: REL_3_0_ALPHA3~192
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=196be8158abc9054c1fb590d5032dc9014a71328;p=poi.git

Minor API doc changes

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

diff --git a/src/examples/src/org/apache/poi/hpsf/examples/CopyCompare.java b/src/examples/src/org/apache/poi/hpsf/examples/CopyCompare.java
index c0325b8589..b2dc3cb8c1 100644
--- a/src/examples/src/org/apache/poi/hpsf/examples/CopyCompare.java
+++ b/src/examples/src/org/apache/poi/hpsf/examples/CopyCompare.java
@@ -173,6 +173,7 @@ public class CopyCompare
      * @exception NoPropertySetStreamException if the application tries to
      * create a property set from a POI document stream that is not a property
      * set stream.
+     * @throws UnsupportedEncodingException 
      * @exception IOException if any I/O exception occurs.
      */
     private static boolean equal(final DirectoryEntry d1,
@@ -252,6 +253,7 @@ public class CopyCompare
      * @exception NoPropertySetStreamException if the application tries to
      * create a property set from a POI document stream that is not a property
      * set stream.
+     * @throws UnsupportedEncodingException 
      * @exception IOException if any I/O exception occurs.
      */
     private static boolean equal(final DocumentEntry d1, final DocumentEntry d2,
@@ -303,7 +305,7 @@ public class CopyCompare
      * everything unmodified to the destination POI filesystem. Property set
      * streams are copied by creating a new {@link PropertySet} from the
      * original property set by using the {@link
-     * MutablePropertySet#MutablePropertySet(PropertySet) constructor.</p>
+     * MutablePropertySet#MutablePropertySet(PropertySet)} constructor.</p>
      */
     static class CopyFile implements POIFSReaderListener
     {
@@ -319,7 +321,6 @@ public class CopyCompare
          * 
          * @param dstName The name of the disk file the destination POIFS is to
          * be written to.
-         * @throws FileNotFoundException
          */
         public CopyFile(final String dstName)
         {
@@ -405,6 +406,8 @@ public class CopyCompare
          * @param path The file's path in the POI filesystem.
          * @param name The file's name in the POI filesystem.
          * @param ps The property set to write.
+         * @throws WritingNotSupportedException 
+         * @throws IOException 
          */
         public void copy(final POIFSFileSystem poiFs,
                          final POIFSDocumentPath path,
@@ -425,7 +428,9 @@ public class CopyCompare
          *
          * @param poiFs The POI filesystem to write to.
          * @param path The source document's path.
+         * @param name The source document's name.
          * @param stream The stream containing the source document.
+         * @throws IOException 
          */
         public void copy(final POIFSFileSystem poiFs,
                          final POIFSDocumentPath path,
diff --git a/src/examples/src/org/apache/poi/hpsf/examples/WriteAuthorAndTitle.java b/src/examples/src/org/apache/poi/hpsf/examples/WriteAuthorAndTitle.java
index f9fe5e9344..56111b3544 100644
--- a/src/examples/src/org/apache/poi/hpsf/examples/WriteAuthorAndTitle.java
+++ b/src/examples/src/org/apache/poi/hpsf/examples/WriteAuthorAndTitle.java
@@ -128,8 +128,8 @@ public class WriteAuthorAndTitle
      * summary information property set and copies everything else unmodified
      * to the destination POI filesystem. Since an instance of it is registered
      * as a {@link POIFSReader} its method {@link 
-     * #processPOIFSReaderEvent(POIFSReaderEvent) is called for each document in
-     * the origin POIFS.</p>
+     * #processPOIFSReaderEvent(POIFSReaderEvent)} is called for each document
+     * in the origin POIFS.</p>
      */
     static class ModifySICopyTheRest implements POIFSReaderListener
     {
@@ -145,7 +145,6 @@ public class WriteAuthorAndTitle
          * 
          * @param dstName The name of the disk file the destination POIFS is to
          * be written to.
-         * @throws FileNotFoundException
          */
         public ModifySICopyTheRest(final String dstName)
         {
@@ -242,12 +241,15 @@ public class WriteAuthorAndTitle
          * @param name The original (and destination) stream's name.
          * @param si The property set. It should be a summary information
          * property set.
+         * @throws IOException 
+         * @throws WritingNotSupportedException 
          */
         public void editSI(final POIFSFileSystem poiFs,
                            final POIFSDocumentPath path,
                            final String name,
                            final PropertySet si)
-            throws WritingNotSupportedException, IOException
+        throws WritingNotSupportedException, IOException
+            
         {
             /* Get the directory entry for the target stream. */
             final DirectoryEntry de = getPath(poiFs, path);
@@ -285,6 +287,8 @@ public class WriteAuthorAndTitle
          * @param path The file's path in the POI filesystem.
          * @param name The file's name in the POI filesystem.
          * @param ps The property set to write.
+         * @throws WritingNotSupportedException 
+         * @throws IOException 
          */
         public void copy(final POIFSFileSystem poiFs,
                          final POIFSDocumentPath path,
@@ -305,7 +309,9 @@ public class WriteAuthorAndTitle
          *
          * @param poiFs The POI filesystem to write to.
          * @param path The source document's path.
+         * @param name The source document's name.
          * @param stream The stream containing the source document.
+         * @throws IOException 
          */
         public void copy(final POIFSFileSystem poiFs,
                          final POIFSDocumentPath path,