Clarify vlen string datatype message (#3950)

HDFGroup · Jan 31, 2024 · d1ed02d · d1ed02d
1 parent bca1dc1
commit d1ed02d
Showing 1 changed file with 19 additions and 5 deletions.
diff --git a/doxygen/examples/H5.format.html b/doxygen/examples/H5.format.html
@@ -10780,6 +10780,12 @@ <h4><a name="DatatypeMessage">IV.A.2.d. The Datatype Message</a></h4>
               <a name="ClassReference"></a>
                 <p>Class specific information for the Reference class (Class 7):</p>
 
+                <p>Note that for region references, the stored data is
+                   a <a href="#GlobalHeapID">Global Heap ID</a> pointing to information
+                   about the region stored in the global heap.
+                </p>
+
+
                 <div align="center">
                   <table class="desc">
                     <caption>
@@ -11118,6 +11124,11 @@ <h4><a name="DatatypeMessage">IV.A.2.d. The Datatype Message</a></h4>
                   <a name="ClassVarLen"></a>
                     <p>Class specific information for the Variable-length class (Class 9):</p>
 
+                    <p>Note that data with a variable length type is stored on the global heap.
+                      Locations that would normally store the data directly (e.g. attribute message)
+                      will instead contain a <a href="#GlobalHeapID">Global Heap ID</a>.
+                    </p>
+
                     <div align="center">
                       <table class="desc">
                         <caption>
@@ -11276,7 +11287,7 @@ <h4><a name="DatatypeMessage">IV.A.2.d. The Datatype Message</a></h4>
                         </tr>
 
                         <tr>
-                          <td colspan="4"><br />Base Type<br /><br /></td>
+                          <td colspan="4"><br />Parent Type Message<br /><br /></td>
                         </tr>
 
                       </table>
@@ -11294,11 +11305,14 @@ <h4><a name="DatatypeMessage">IV.A.2.d. The Datatype Message</a></h4>
 	                    </tr>
 
 	                    <tr>
-	                      <td><p>Base Type</p></td>
+	                      <td><p>Parent Type</p></td>
 	                      <td>
-                            <p>Each variable-length type is based on some parent type.  The
-                              information for that parent type is described recursively by
-                              this field.
+                            <p>Each variable-length type is based on some parent type.
+                              This field contains the datatype message describing that parent type.
+                              In the case of nested variable-length types, this parent datatype message will
+                              recursively contain all parent datatype messages.
+
+                              Variable-length strings are considered to have the parent type `H5T_NATIVE_UCHAR`.
                             </p>
                           </td>
 	                    </tr>