poi-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kl...@apache.org
Subject svn commit: r374728 - in /jakarta/poi/trunk/src/examples/src/org/apache/poi/hpsf/examples: CopyCompare.java WriteAuthorAndTitle.java
Date Fri, 03 Feb 2006 19:08:25 GMT
Author: klute
Date: Fri Feb  3 11:08:14 2006
New Revision: 374728

URL: http://svn.apache.org/viewcvs?rev=374728&view=rev
Log:
Minor API doc changes

Modified:
    jakarta/poi/trunk/src/examples/src/org/apache/poi/hpsf/examples/CopyCompare.java
    jakarta/poi/trunk/src/examples/src/org/apache/poi/hpsf/examples/WriteAuthorAndTitle.java

Modified: jakarta/poi/trunk/src/examples/src/org/apache/poi/hpsf/examples/CopyCompare.java
URL: http://svn.apache.org/viewcvs/jakarta/poi/trunk/src/examples/src/org/apache/poi/hpsf/examples/CopyCompare.java?rev=374728&r1=374727&r2=374728&view=diff
==============================================================================
--- jakarta/poi/trunk/src/examples/src/org/apache/poi/hpsf/examples/CopyCompare.java (original)
+++ jakarta/poi/trunk/src/examples/src/org/apache/poi/hpsf/examples/CopyCompare.java Fri Feb
 3 11:08:14 2006
@@ -173,6 +173,7 @@
      * @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 @@
      * @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 @@
      * 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 @@
          * 
          * @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 @@
          * @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 @@
          *
          * @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,

Modified: jakarta/poi/trunk/src/examples/src/org/apache/poi/hpsf/examples/WriteAuthorAndTitle.java
URL: http://svn.apache.org/viewcvs/jakarta/poi/trunk/src/examples/src/org/apache/poi/hpsf/examples/WriteAuthorAndTitle.java?rev=374728&r1=374727&r2=374728&view=diff
==============================================================================
--- jakarta/poi/trunk/src/examples/src/org/apache/poi/hpsf/examples/WriteAuthorAndTitle.java
(original)
+++ jakarta/poi/trunk/src/examples/src/org/apache/poi/hpsf/examples/WriteAuthorAndTitle.java
Fri Feb  3 11:08:14 2006
@@ -128,8 +128,8 @@
      * 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 @@
          * 
          * @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 @@
          * @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 @@
          * @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 @@
          *
          * @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,



---------------------------------------------------------------------
To unsubscribe, e-mail: poi-dev-unsubscribe@jakarta.apache.org
Mailing List:    http://jakarta.apache.org/site/mail2.html#poi
The Apache Jakarta POI Project: http://jakarta.apache.org/poi/


Mime
View raw message