PDFBOX-5660: improve javadoc; closes #198

git-svn-id: https://svn.apache.org/repos/asf/pdfbox/trunk@1922631 13f79535-47bb-0310-9956-ffa450edef68
apache · Dec 22, 2024 · 703136e · 703136e
1 parent 187a3a0
commit 703136e
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 7 deletions.
diff --git a/pdfbox/src/main/java/org/apache/pdfbox/Loader.java b/pdfbox/src/main/java/org/apache/pdfbox/Loader.java
@@ -365,7 +365,8 @@ public static PDDocument loadPDF(File file, String password, InputStream keyStor
     /**
      * Parses a PDF. Unrestricted main memory will be used for buffering PDF new streams.
      * 
-     * @param randomAccessRead random access read representing the pdf to be loaded
+     * @param randomAccessRead random access read representing the pdf to be loaded. To pass an
+     * InputStream, wrap it into a {@link RandomAccessReadBuffer}.
      * 
      * @return loaded document
      * 
@@ -380,7 +381,8 @@ public static PDDocument loadPDF(RandomAccessRead randomAccessRead) throws IOExc
     /**
      * Parses a PDF.
      * 
-     * @param randomAccessRead random access read representing the pdf to be loaded
+     * @param randomAccessRead random access read representing the pdf to be loaded. To pass an
+     * InputStream, wrap it into a {@link RandomAccessReadBuffer}.
      * @param streamCacheCreateFunction a function to create an instance of a stream cache to be used for buffering
      * new/altered PDF streams
      * 
@@ -399,7 +401,8 @@ public static PDDocument loadPDF(RandomAccessRead randomAccessRead,
     /**
      * Parses a PDF. Unrestricted main memory will be used for buffering new/altered PDF streams.
      *
-     * @param randomAccessRead random access read representing the pdf to be loaded
+     * @param randomAccessRead random access read representing the pdf to be loaded. To pass an
+     * InputStream, wrap it into a {@link RandomAccessReadBuffer}.
      * @param password password to be used for decryption
      *
      * @return loaded document
@@ -416,7 +419,8 @@ public static PDDocument loadPDF(RandomAccessRead randomAccessRead, String passw
     /**
      * Parses a PDF. Unrestricted main memory will be used for buffering new/altered PDF streams.
      *
-     * @param randomAccessRead random access read representing the pdf to be loaded
+     * @param randomAccessRead random access read representing the pdf to be loaded. To pass an
+     * InputStream, wrap it into a {@link RandomAccessReadBuffer}.
      * @param password password to be used for decryption
      * @param keyStore key store to be used for decryption when using public key security
      * @param alias alias to be used for decryption when using public key security
@@ -435,7 +439,8 @@ public static PDDocument loadPDF(RandomAccessRead randomAccessRead, String passw
     /**
      * Parses a PDF.
      *
-     * @param randomAccessRead random access read representing the pdf to be loaded
+     * @param randomAccessRead random access read representing the pdf to be loaded. To pass an
+     * InputStream, wrap it into a {@link RandomAccessReadBuffer}.
      * @param password password to be used for decryption
      * @param streamCacheCreateFunction a function to create an instance of a stream cache to be used for buffering
      * new/altered PDF streams
@@ -454,7 +459,8 @@ public static PDDocument loadPDF(RandomAccessRead randomAccessRead, String passw
     /**
      * Parses a PDF.
      * 
-     * @param randomAccessRead random access read representing the pdf to be loaded
+     * @param randomAccessRead random access read representing the pdf to be loaded. To pass an
+     * InputStream, wrap it into a {@link RandomAccessReadBuffer}.
      * @param password password to be used for decryption
      * @param keyStore key store to be used for decryption when using public key security
      * @param alias alias to be used for decryption when using public key security

diff --git a/pdfbox/src/main/java/org/apache/pdfbox/multipdf/PDFMergerUtility.java b/pdfbox/src/main/java/org/apache/pdfbox/multipdf/PDFMergerUtility.java
@@ -43,6 +43,7 @@
 import org.apache.pdfbox.cos.COSStream;
 import org.apache.pdfbox.io.IOUtils;
 import org.apache.pdfbox.io.RandomAccessRead;
+import org.apache.pdfbox.io.RandomAccessReadBuffer;
 import org.apache.pdfbox.io.RandomAccessStreamCache.StreamCacheCreateFunction;
 import org.apache.pdfbox.pdfwriter.compress.CompressParameters;
 import org.apache.pdfbox.pdmodel.PDDocument;
@@ -310,7 +311,8 @@ public void addSource(File source) throws FileNotFoundException
     /**
      * Add a source to the list of documents to merge.
      *
-     * @param source RandomAccessRead representing source document
+     * @param source RandomAccessRead representing source document. To pass an InputStream, wrap it
+     * into a {@link RandomAccessReadBuffer}.
      */
     public void addSource(RandomAccessRead source)
     {