aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarius Volkhart <mariusvolkhart@apache.org>2021-02-17 14:48:30 +0000
committerMarius Volkhart <mariusvolkhart@apache.org>2021-02-17 14:48:30 +0000
commit5d9dcdf3df1a7c6996117c84f798d1ce6b94e215 (patch)
tree894f7ed1b13ca924fe4b026406cd67b18aed1cd2
parentbcf413f68a64024ca7c4cd8efadc718576ddaf4f (diff)
downloadpoi-5d9dcdf3df1a7c6996117c84f798d1ce6b94e215.tar.gz
poi-5d9dcdf3df1a7c6996117c84f798d1ce6b94e215.zip
Add documentation for DrawingGroupRecord
Documentation adapted from [MS-XLS].pdf v20190618. git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1886619 13f79535-47bb-0310-9956-ffa450edef68
-rw-r--r--src/java/org/apache/poi/hssf/record/DrawingGroupRecord.java10
1 files changed, 9 insertions, 1 deletions
diff --git a/src/java/org/apache/poi/hssf/record/DrawingGroupRecord.java b/src/java/org/apache/poi/hssf/record/DrawingGroupRecord.java
index 692dc842f7..68c8c24145 100644
--- a/src/java/org/apache/poi/hssf/record/DrawingGroupRecord.java
+++ b/src/java/org/apache/poi/hssf/record/DrawingGroupRecord.java
@@ -22,10 +22,18 @@ import java.util.Map;
import java.util.function.Supplier;
import org.apache.poi.ddf.EscherRecord;
+import org.apache.poi.ddf.EscherRecordTypes;
import org.apache.poi.ddf.NullEscherSerializationListener;
import org.apache.poi.util.LittleEndian;
-
+/**
+ * Specifies a group of drawing objects.
+ * <p>
+ * Contains a single {@link EscherRecordTypes#DGG_CONTAINER OfficeArtDggContainer} that specifies the group of drawing
+ * objects. Get the {@link org.apache.poi.ddf.EscherContainerRecord} representation via {@link #getEscherContainer()}.
+ * <p>
+ * Referred to as an {@code MsoDrawingGroup} in {@code [MS-XLS].pdf v20190618}.
+ */
public final class DrawingGroupRecord extends AbstractEscherHolderRecord {
public static final short sid = 0xEB;