From: Glen Stampoultzis <glens@apache.org>
Date: Sat, 9 Mar 2002 04:45:46 +0000 (+0000)
Subject: More record generation goodness.
X-Git-Tag: prelogging~50
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=631d80706ed3db6258bcbb13d750d3b640cfcfa1;p=poi.git

More record generation goodness.


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

diff --git a/src/documentation/xdocs/hssf/record-generator.xml b/src/documentation/xdocs/hssf/record-generator.xml
index 2b2aba6a10..fb5ca7d957 100644
--- a/src/documentation/xdocs/hssf/record-generator.xml
+++ b/src/documentation/xdocs/hssf/record-generator.xml
@@ -60,6 +60,14 @@
         </fields>
     </record>
         ]]></source>
+        <p>
+            Currently the type can be of type int, float or string.  The 'int' type covers bytes, shorts and
+            integers which is selected using a size of 1, 2 or 4.
+            An additional type called varword is used to represent a array of word values where the first short
+            is the length of the array.
+            The string type generation is only partially implemented.  If choosing string you must select a size
+            of 'var'.
+        </p>
         <p>
             The Java records are regenerated each time the record generator is run, however the test stubs are
             only created if the test stub does not already exist.  What this means is that you may change
@@ -68,13 +76,16 @@
     </s2>
     <s2 title="How it Works">
         <p>
-            TODO: Fill this out more
+            The record generation works by taking an XML file and styling it using XLST.  Given that
+            XSLT is a little limited in some ways it was necessary to add a little Java code to the mix.
+            This would probably have been better off done as javascript and may well be migrated in the
+            near future. Since the current Java code was written as a proof of concept it's a little
+            lacking in commenting and structure.  Since this is converted to Javascript this should no
+            longer be a problem.
         </p>
         <p>
             See record.xsl, record_test.xsl, FieldIterator.java, RecordUtil.java, RecordGenerator.java
         </p>
-        <p>
-        </p>
     </s2>
     <s2 title="Limitations">
         <p>