aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarius Volkhart <mariusvolkhart@apache.org>2021-02-28 15:08:39 +0000
committerMarius Volkhart <mariusvolkhart@apache.org>2021-02-28 15:08:39 +0000
commit12857e68ac370a09c2cd2745c0c97789899d7711 (patch)
treed6a3a47c73cfe033721a51567a790dd0ca821099
parentcfee75c9b6e0d56216e1131139d229e45d64824b (diff)
downloadpoi-12857e68ac370a09c2cd2745c0c97789899d7711.tar.gz
poi-12857e68ac370a09c2cd2745c0c97789899d7711.zip
Add documentation for HWPF FileInformationBlock DggInfo methods
This documentation comes from [MS-DOC] - v20191119. git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1886998 13f79535-47bb-0310-9956-ffa450edef68
-rw-r--r--src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java b/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java
index fdb220540a..f002f3b0b9 100644
--- a/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java
+++ b/src/scratchpad/src/org/apache/poi/hwpf/model/FileInformationBlock.java
@@ -1004,11 +1004,21 @@ public final class FileInformationBlock {
return _fieldHandler.getFieldSize(FIBFieldHandler.PLCSPAMOM);
}
+ /**
+ * @return Offset in the Table Stream at which the {@link EscherRecordHolder} exists.
+ */
public int getFcDggInfo()
{
return _fieldHandler.getFieldOffset(FIBFieldHandler.DGGINFO);
}
+ /**
+ * Returns the size, in bytes, of the {@link EscherRecordHolder} at the offset {@link #getFcDggInfo()}.
+ * <p>
+ * If {@code 0}, there MUST NOT be any drawings in the document.
+ *
+ * @return Size, in bytes, of the {@link EscherRecordHolder} at the offset {@link #getFcDggInfo()}.
+ */
public int getLcbDggInfo()
{
return _fieldHandler.getFieldSize(FIBFieldHandler.DGGINFO);