You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ti...@apache.org on 2024/10/30 14:30:28 UTC
svn commit: r1921686 - /pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/logicalstructure/PDStructureNode.java
Author: tilman
Date: Wed Oct 30 14:30:28 2024
New Revision: 1921686
URL: http://svn.apache.org/viewvc?rev=1921686&view=rev
Log:
PDFBOX-5660: improve javadoc
Modified:
pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/logicalstructure/PDStructureNode.java
Modified: pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/logicalstructure/PDStructureNode.java
URL: http://svn.apache.org/viewvc/pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/logicalstructure/PDStructureNode.java?rev=1921686&r1=1921685&r2=1921686&view=diff
==============================================================================
--- pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/logicalstructure/PDStructureNode.java (original)
+++ pdfbox/trunk/pdfbox/src/main/java/org/apache/pdfbox/pdmodel/documentinterchange/logicalstructure/PDStructureNode.java Wed Oct 30 14:30:28 2024
@@ -144,7 +144,7 @@ public abstract class PDStructureNode im
}
/**
- * Appends a structure element kid.
+ * Appends a structure element kid and sets the parent property (/P) to this.
*
* @param structureElement the structure element
*/
@@ -270,10 +270,10 @@ public abstract class PDStructureNode im
}
/**
- * Removes a structure element kid.
- *
+ * Removes a structure element kid and if successful also removes the parent property (/P).
+ *
* @param structureElement the structure element
- * @return <code>true</code> if the kid was removed, <code>false</code> otherwise
+ * @return <code>true</code> if the kid was removed, <code>false</code> otherwise.
*/
public boolean removeKid(PDStructureElement structureElement)
{