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

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 fdb220540abd7f679e8395672588d521159570b2..f002f3b0b9d38a4d464d89fe317c4e0861cfed36 100644 (file)
--- 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);