You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by le...@apache.org on 2022/11/04 07:25:40 UTC

svn commit: r1905058 - in /pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox: contentstream/operator/OperatorProcessor.java cos/COSDictionary.java cos/COSDocument.java cos/COSInputStream.java cos/COSStream.java cos/COSString.java

Author: lehmi
Date: Fri Nov  4 07:25:39 2022
New Revision: 1905058

URL: http://svn.apache.org/viewvc?rev=1905058&view=rev
Log:
PDFBOX-4892: fix javadoc

Modified:
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/contentstream/operator/OperatorProcessor.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDictionary.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSInputStream.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSStream.java
    pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSString.java

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/contentstream/operator/OperatorProcessor.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/contentstream/operator/OperatorProcessor.java?rev=1905058&r1=1905057&r2=1905058&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/contentstream/operator/OperatorProcessor.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/contentstream/operator/OperatorProcessor.java Fri Nov  4 07:25:39 2022
@@ -34,6 +34,8 @@ public abstract class OperatorProcessor
 
     /**
      * Creates a new OperatorProcessor.
+     * 
+     * @param context the processing context to be used
      */
     protected OperatorProcessor(PDFStreamEngine context)
     {
@@ -60,6 +62,8 @@ public abstract class OperatorProcessor
 
     /**
      * Returns the name of this operator, e.g. "BI".
+     * 
+     * @return the name of the operator
      */
     public abstract String getName();
     
@@ -68,7 +72,7 @@ public abstract class OperatorProcessor
      *
      * @param operands The operands list.
      * @param clazz The expected class.
-     * @return the boolean
+     * @return true if all operands list elements are an instance of the given class
      */
     public boolean checkArrayTypesClass(List<COSBase> operands, Class<?> clazz)
     {

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDictionary.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDictionary.java?rev=1905058&r1=1905057&r2=1905058&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDictionary.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDictionary.java Fri Nov  4 07:25:39 2022
@@ -1233,10 +1233,10 @@ public class COSDictionary extends COSBa
     }
 
     /**
-     * Convenience method that calls
-     * {@link Map#forEach(java.util.function.BiConsumer) Map.forEach(BiConsumer)}.
+     * Convenience method that calls {@link Map#forEach(java.util.function.BiConsumer) Map.forEach(BiConsumer)}.
      *
-     * @param action
+     * @param action The action to be performed for each entry
+     * 
      */
     public void forEach(BiConsumer<? super COSName, ? super COSBase> action)
     {

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java?rev=1905058&r1=1905057&r2=1905058&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSDocument.java Fri Nov  4 07:25:39 2022
@@ -474,6 +474,8 @@ public class COSDocument extends COSBase
 
     /**
      * Returns true if this document has been closed.
+     * 
+     * @return true if the document is already closed, false otherwise
      */
     public boolean isClosed()
     {

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSInputStream.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSInputStream.java?rev=1905058&r1=1905057&r2=1905058&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSInputStream.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSInputStream.java Fri Nov  4 07:25:39 2022
@@ -109,6 +109,8 @@ public final class COSInputStream extend
     
     /**
      * Returns the result of the last filter, for use by repair mechanisms.
+     * 
+     * @return the result of the last filter
      */
     public DecodeResult getDecodeResult()
     {

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSStream.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSStream.java?rev=1905058&r1=1905057&r2=1905058&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSStream.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSStream.java Fri Nov  4 07:25:39 2022
@@ -390,6 +390,8 @@ public class COSStream extends COSDictio
     
     /**
      * Returns the contents of the stream as a PDF "text string".
+     * 
+     * @return the PDF string representation of the stream content
      */
     public String toTextString()
     {
@@ -415,10 +417,10 @@ public class COSStream extends COSDictio
     /**
      * {@inheritDoc}
      *
-     * Called by PDFBox when the PDDocument is closed, this closes the stream and removes the data.
-     * You will usually not need this.
+     * Called by PDFBox when the PDDocument is closed, this closes the stream and removes the data. You will usually not
+     * need this.
      *
-     * @throws IOException
+     * @throws IOException if something went wrong when closing the stream
      */
     @Override
     public void close() throws IOException

Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSString.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSString.java?rev=1905058&r1=1905057&r2=1905058&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSString.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/cos/COSString.java Fri Nov  4 07:25:39 2022
@@ -167,6 +167,8 @@ public final class COSString extends COS
 
     /**
      * Returns true if the string is to be written in hex form.
+     * 
+     * @return true if the COSString is written in hex form
      */
     public boolean getForceHexForm()
     {
@@ -175,6 +177,8 @@ public final class COSString extends COS
 
     /**
      * Returns the content of this string as a PDF <i>text string</i>.
+     * 
+     * @return the PDF string representation of the COSString
      */
     public String getString()
     {
@@ -199,6 +203,8 @@ public final class COSString extends COS
 
     /**
      * Returns the content of this string as a PDF <i>ASCII string</i>.
+     * 
+     * @return the ASCII string representation of the COSString
      */
     public String getASCII()
     {
@@ -208,6 +214,8 @@ public final class COSString extends COS
 
     /**
      * Returns the raw bytes of the string using a new byte array. Best used with a PDF <i>byte string</i>.
+     * 
+     * @return a clone of the underlying byte[] representation of the COSString
      */
     public byte[] getBytes()
     {