]> source.dussan.org Git - poi.git/commitdiff
Add documentation for DrawingGroupRecord
authorMarius Volkhart <mariusvolkhart@apache.org>
Wed, 17 Feb 2021 14:48:30 +0000 (14:48 +0000)
committerMarius Volkhart <mariusvolkhart@apache.org>
Wed, 17 Feb 2021 14:48:30 +0000 (14:48 +0000)
Documentation adapted from [MS-XLS].pdf v20190618.

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

src/java/org/apache/poi/hssf/record/DrawingGroupRecord.java

index 692dc842f76707c28e219c3feec5981a80c16842..68c8c24145d698f92ad5025d67556aeb4d480763 100644 (file)
@@ -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;