From: Sergey Vladimirov <sergey@apache.org>
Date: Fri, 8 Jul 2011 10:01:16 +0000 (+0000)
Subject: add documentation
X-Git-Tag: REL_3_8_BETA4~266
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=ce458a4cd41902b97c13b9f6f7f10b2e26cb53a2;p=poi.git

add documentation

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

diff --git a/src/scratchpad/src/org/apache/poi/hwpf/model/FieldsTables.java b/src/scratchpad/src/org/apache/poi/hwpf/model/FieldsTables.java
index 826bc30a7d..acbc32f6e8 100644
--- a/src/scratchpad/src/org/apache/poi/hwpf/model/FieldsTables.java
+++ b/src/scratchpad/src/org/apache/poi/hwpf/model/FieldsTables.java
@@ -22,7 +22,6 @@ package org.apache.poi.hwpf.model;
 import java.util.ArrayList;
 import java.util.HashMap;
 
-
 /**
  * This class provides access to all the fields Plex.
  * 
@@ -31,16 +30,37 @@ import java.util.HashMap;
  */
 public class FieldsTables
 {
-  public static final int PLCFFLDATN = 0;
-  public static final int PLCFFLDEDN = 1;
-  public static final int PLCFFLDFTN = 2;
-  public static final int PLCFFLDHDR = 3;
-  public static final int PLCFFLDHDRTXBX = 4;
-  public static final int PLCFFLDMOM = 5;
-  public static final int PLCFFLDTXBX = 6;
+    /**
+     * annotation subdocument
+     */
+    public static final int PLCFFLDATN = 0;
+    /**
+     * endnote subdocument
+     */
+    public static final int PLCFFLDEDN = 1;
+    /**
+     * footnote subdocument
+     */
+    public static final int PLCFFLDFTN = 2;
+    /**
+     * header subdocument
+     */
+    public static final int PLCFFLDHDR = 3;
+    /**
+     * header textbox subdoc
+     */
+    public static final int PLCFFLDHDRTXBX = 4;
+    /**
+     * main document
+     */
+    public static final int PLCFFLDMOM = 5;
+    /**
+     * textbox subdoc
+     */
+    public static final int PLCFFLDTXBX = 6;
 
-  // The size in bytes of the FLD data structure
-  private static final int FLD_SIZE = 2;
+    // The size in bytes of the FLD data structure
+    private static final int FLD_SIZE = 2;
 
   private HashMap<Integer, ArrayList<PlexOfField>> _tables;