svn commit: r1835158 - in /pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox: exceptions/ pdfwriter/ persistence/util/

[ti...@apache.org]

Author: tilman
Date: Thu Jul  5 17:25:52 2018
New Revision: 1835158

URL: http://svn.apache.org/viewvc?rev=1835158&view=rev
Log:
PDFBOX-4071: improve javadoc

Modified:
    pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/exceptions/COSVisitorException.java
    pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/exceptions/WrappedException.java
    pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/exceptions/WrappedIOException.java
    pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSStandardOutputStream.java
    pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSWriter.java
    pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSWriterXRefEntry.java
    pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/persistence/util/COSObjectKey.java

Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/exceptions/COSVisitorException.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/exceptions/COSVisitorException.java?rev=1835158&r1=1835157&r2=1835158&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/exceptions/COSVisitorException.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/exceptions/COSVisitorException.java Thu Jul  5 17:25:52 2018
@@ -26,7 +26,7 @@ public class COSVisitorException extends
 {
 
     /**
-     * COSVisitorException constructor comment.
+     * Constructor.
      *
      * @param e The root exception that caused this exception.
      */

Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/exceptions/WrappedException.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/exceptions/WrappedException.java?rev=1835158&r1=1835157&r2=1835158&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/exceptions/WrappedException.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/exceptions/WrappedException.java Thu Jul  5 17:25:52 2018
@@ -28,7 +28,7 @@ package org.apache.pdfbox.exceptions;
 public class WrappedException extends Exception
 {
     /**
-     * constructor comment.
+     * Constructor.
      *
      * @param e The root exception that caused this exception.
      */

Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/exceptions/WrappedIOException.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/exceptions/WrappedIOException.java?rev=1835158&r1=1835157&r2=1835158&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/exceptions/WrappedIOException.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/exceptions/WrappedIOException.java Thu Jul  5 17:25:52 2018
@@ -27,7 +27,7 @@ import java.io.IOException;
 public class WrappedIOException extends IOException
 {
     /**
-     * constructor comment.
+     * Constructor.
      *
      * @param e The root exception that caused this exception.
      */
@@ -37,7 +37,7 @@ public class WrappedIOException extends
     }
 
     /**
-     * constructor comment.
+     * Constructor.
      *
      * @param message Descriptive text for the exception.
      * @param e The root exception that caused this exception.

Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSStandardOutputStream.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSStandardOutputStream.java?rev=1835158&r1=1835157&r2=1835158&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSStandardOutputStream.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSStandardOutputStream.java Thu Jul  5 17:25:52 2018
@@ -63,7 +63,7 @@ public class COSStandardOutputStream ext
     private long mark = -1;
     
     /**
-     * COSOutputStream constructor comment.
+     * Constructor.
      *
      * @param out The underlying stream to write to.
      */

Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSWriter.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSWriter.java?rev=1835158&r1=1835157&r2=1835158&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSWriter.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSWriter.java Thu Jul  5 17:25:52 2018
@@ -218,7 +218,7 @@ public class COSWriter implements ICOSVi
     private InputStream in;
 
     /**
-     * COSWriter constructor comment.
+     * Constructor.
      *
      * @param os The wrapped output stream.
      */

Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSWriterXRefEntry.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSWriterXRefEntry.java?rev=1835158&r1=1835157&r2=1835158&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSWriterXRefEntry.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/pdfwriter/COSWriterXRefEntry.java Thu Jul  5 17:25:52 2018
@@ -127,7 +127,7 @@ public class COSWriterXRefEntry implemen
     }
 
     /**
-     * COSWriterXRefEntry constructor comment.
+     * Constructor.
      *
      * @param start The start attribute.
      * @param obj The COS object that this entry represents.

Modified: pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/persistence/util/COSObjectKey.java
URL: http://svn.apache.org/viewvc/pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/persistence/util/COSObjectKey.java?rev=1835158&r1=1835157&r2=1835158&view=diff
==============================================================================
--- pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/persistence/util/COSObjectKey.java (original)
+++ pdfbox/branches/1.8/pdfbox/src/main/java/org/apache/pdfbox/persistence/util/COSObjectKey.java Thu Jul  5 17:25:52 2018
@@ -30,7 +30,7 @@ public class COSObjectKey implements Com
     private long generation;
 
     /**
-     * PDFObjectKey constructor comment.
+     * Constructor.
      *
      * @param object The object that this key will represent.
      */
@@ -40,7 +40,7 @@ public class COSObjectKey implements Com
     }
 
     /**
-     * PDFObjectKey constructor comment.
+     * Constructor.
      *
      * @param num The object number.
      * @param gen The object generation number.