PDFBOX-5660: improve javadoc

git-svn-id: https://svn.apache.org/repos/asf/pdfbox/trunk@1922880 13f79535-47bb-0310-9956-ffa450edef68
apache · Jan 4, 2025 · 15cfc50 · 15cfc50
1 parent ea271d3
commit 15cfc50
Showing 1 changed file with 7 additions and 3 deletions.
diff --git a/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java b/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/PDDocument.java
@@ -647,8 +647,10 @@ private void assignAcroFormDefaultResource(PDAcroForm acroForm, COSDictionary ne
     }
 
     /**
-     * Remove the page from the document.
-     * 
+     * Remove the page from the document. Do not use this method if other pages link to this one or
+     * if your document has a structure tree for accessibility unless you are able to fix these as
+     * well. In such cases it is better to use the splitter() class which will do these fixes.
+     *
      * @param page The page to remove from the document.
      */
     public void removePage(PDPage page)
@@ -657,7 +659,9 @@ public void removePage(PDPage page)
     }
 
     /**
-     * Remove the page from the document.
+     * Remove the page from the document. Do not use this method if other pages link to this one or
+     * if your document has a structure tree for accessibility unless you are able to fix these as
+     * well. In such cases it is better to use the splitter() class which will do these fixes.
      * 
      * @param pageNumber 0 based index to page number.
      */