From: Marius Volkhart <mariusvolkhart@apache.org>
Date: Tue, 9 Mar 2021 18:28:59 +0000 (+0000)
Subject: Cleanup documentation of EscherChildAnchorRecord and EscherClientAnchorRecord
X-Git-Tag: REL_5_1_0~326
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=c05dbedbc56e5018f36b877d97b9c18d87da1279;p=poi.git

Cleanup documentation of EscherChildAnchorRecord and EscherClientAnchorRecord

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1887391 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/src/java/org/apache/poi/ddf/EscherChildAnchorRecord.java b/src/java/org/apache/poi/ddf/EscherChildAnchorRecord.java
index 61794bf867..bf15c83047 100644
--- a/src/java/org/apache/poi/ddf/EscherChildAnchorRecord.java
+++ b/src/java/org/apache/poi/ddf/EscherChildAnchorRecord.java
@@ -25,10 +25,12 @@ import org.apache.poi.util.GenericRecordUtil;
 import org.apache.poi.util.LittleEndian;
 
 /**
- * The escher child achor record is used to specify the position of a shape under an
- * existing group.  The first level of shape records use a EscherClientAnchor record instead.
+ * The escher child anchor record is used to specify the position of a shape under an
+ * existing group.
+ * <p>
+ * The first level of shape records use a {@link EscherClientAnchorRecord} instead.
  *
- * @see EscherChildAnchorRecord
+ * @see EscherClientAnchorRecord
  */
 public class EscherChildAnchorRecord extends EscherRecord {
     public static final short RECORD_ID = EscherRecordTypes.CHILD_ANCHOR.typeID;
diff --git a/src/java/org/apache/poi/ddf/EscherClientAnchorRecord.java b/src/java/org/apache/poi/ddf/EscherClientAnchorRecord.java
index 64d985b9a9..5d182da247 100644
--- a/src/java/org/apache/poi/ddf/EscherClientAnchorRecord.java
+++ b/src/java/org/apache/poi/ddf/EscherClientAnchorRecord.java
@@ -29,7 +29,8 @@ import org.apache.poi.util.LittleEndian;
  * The escher client anchor specifies which rows and cells the shape is bound to as well as
  * the offsets within those cells.  Each cell is 1024 units wide by 256 units long regardless
  * of the actual size of the cell.  The EscherClientAnchorRecord only applies to the top-most
- * shapes.  Shapes contained in groups are bound using the EscherChildAnchorRecords.
+ * shapes. Shapes contained in groups are bound using the EscherChildAnchorRecords. Referred to as an
+ * {@code OfficeArtClientAnchor} by {@code [MS-PPT] - v20210216}.
  *
  * @see EscherChildAnchorRecord
  */