[svn-r1206] RM_H5R.html

	Corrected parameter and return types in function prototypes
		and parameter descriptions
	Deleted comments regarding unimplemented functionality in R1.0
		which has since been implemented
	Cleaned up formatting of commands TOC at top of page

References.html
	Corrected parameter and return types in function prototypes
		and in example code
	Deleted comments regarding unimplemented functionality in R1.0
		which has since been implemented

2 files changed, 20 insertions, 33 deletions

diff --git a/doc/html/RM_H5R.html b/doc/html/RM_H5R.html
index b558e81..d138670 100644
--- a/doc/html/RM_H5R.html
+++ b/doc/html/RM_H5R.html
@@ -52,35 +52,30 @@ The Reference interface allows the user to create references
 to specific objects and data regions in an HDF5 file.
 <p>
 
-<table border=0>
-<tr><td valign=top>
+
+<table border=0 width=98%>
+<tr><td valign=top width=33%>
 <ul>
     <li><a href="#Reference-Create">H5Rcreate</a>
 </ul>
-</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
+</td><td valign=top width=33%>
 <ul>
     <li><a href="#Reference-Dereference">H5Rdereference</a>
 </ul>
-</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
+</td><td valign=top width=34%>
 <ul>
-    <li><a href="#Reference-GetRegion">H5Rget_region</a> (NYI)
+    <li><a href="#Reference-GetRegion">H5Rget_region</a>
 </ul>
 </td></tr>
-<tr><td colspan=5 align=right><font size=-1>
-NYI = Not yet implemented.</font>
-</td></tr>
 </table>
 
 <p>
-<i>Note: The only type of reference implemented in this release 
-is an object reference pointing to a dataset.</i>
-<p>
 
 <hr>
 <dl>
 <dt><strong>Name:</strong> <a name="Reference-Create">H5Rcreate</a>
 <dt><strong>Signature:</strong>
-    <dd><em>herr_t</em> <code>H5Rcreate</code>(<em>href_t *</em><code>ref</code>,
+    <dd><em>herr_t</em> <code>H5Rcreate</code>(<em>void *</em><code>ref</code>,
         <em>hid_t</em> <code>loc_id</code>,
         <em>const char *</em><code>name</code>,
         <em>H5R_type_t</em> <code>ref_type</code>,
@@ -98,12 +93,9 @@ is an object reference pointing to a dataset.</i>
         <p>
         The parameter <code>space_id</code> identifies the region 
         to be pointed to (for dataset region references).  
-        <p>
-        <i>Note: Only object references of type <code>H5T_STD_REF_OBJ</code>
-        pointing to entire datasets are implemented at this time.</i>
 <dt><strong>Parameters:</strong>
     <dl>
-        <dt><em>href_t *</em><code>ref</code>
+        <dt><em>void *</em><code>ref</code>
             <dd>OUT: Reference created by the function call.
         <dt><em>hid_t</em> <code>loc_id</code>
             <dd>IN: Location identifier used to locate the object being 
@@ -128,7 +120,7 @@ is an object reference pointing to a dataset.</i>
 <dt><strong>Signature:</strong>
     <dd><em>hid_t</em> <code>H5Rdereference</code>(<em>hid_t</em> <code>dataset</code>,
         <em>H5R_type_t</em> <code>ref_type</code>,
-        <em>href_t *</em><code>ref</code>
+        <em>void *</em><code>ref</code>
     )
 <dt><strong>Purpose:</strong>
     <dd>Opens the HDF5 object referenced.
@@ -161,9 +153,9 @@ is an object reference pointing to a dataset.</i>
 <dt><strong>Name:</strong> <a name="Reference-GetRegion">H5Rget_region</a>
 &nbsp;&nbsp;<i>(Not yet implemented.)</i>
 <dt><strong>Signature:</strong>
-    <dd><em>hid_t</em> <code>H5Rget_region</code>(<em>hid_t</em> <code>dataset</code>,
+    <dd><em>H5S_t</em> <code>H5Rget_region</code>(<em>H5D_t</em> <code>dataset</code>,
     <em>H5R_type_t</em> <code>ref_type</code>,
-    <em>href_t *</em><code>ref</code>
+    <em>void *</em><code>ref</code>
     )
 <dt><strong>Purpose:</strong>
     <dd>Retrieves a dataspace with the specified region selected.
@@ -184,7 +176,7 @@ is an object reference pointing to a dataset.</i>
             <dd>IN: Dataset containing reference object.
         <dt><em>H5R_type_t</em> <code>ref_type</code>,
             <dd>IN: The reference type of <code>ref</code>.
-        <dt><em>href_t *</em><code>ref</code>
+        <dt><em>void *</em><code>ref</code>
             <dd>IN: Reference to open.
     </dl>
 <dt><strong>Returns:</strong>
diff --git a/doc/html/References.html b/doc/html/References.html
index 24a26ee..e985f8d 100644
--- a/doc/html/References.html
+++ b/doc/html/References.html
@@ -158,7 +158,7 @@ H5I interface,  have been implemented to support references.
 The H5I function is also useful outside the context of references.
 <p>
 <dl>
-    <dt><em>herr_t</em> <code>H5Rcreate(</code><em>href_t *</em><code>reference,</code>
+    <dt><em>herr_t</em> <code>H5Rcreate(</code><em>void *</em><code>reference,</code>
         <em>hid_t</em> <code>loc_id,</code>
         <em>const char *</em><code>name,</code>
         <em>H5R_type_t</em> <code>type,</code>
@@ -171,23 +171,20 @@ The H5I function is also useful outside the context of references.
         in the dataspace is the portion of the dataset which 
         will be referred to.
         <p>
-        <em>Currently only object references which point to 
-        entire datasets can be created.</em>
-        <p>
 
     <dt><em>hid_t</em> <code>H5Rdereference(</code><em>hid_t</em> <code>dset,</code>
         <em>H5R_type_t</em> <code>rtype,</code>
-        <em>href_t *</em><code>ref)</code>
+        <em>void *</em><code>reference)</code>
     <dd><code>H5Rdereference</code> opens the object referenced 
         and returns an identifier for that object.
-        The parameter <code>ref</code> specifies a reference of 
+        The parameter <code>reference</code> specifies a reference of 
         type <code>rtype</code> that is stored in the dataset 
         <code>dset</code>.
         <p>
 
-    <dt><em>hid_t</em> <code>H5Rget_region(</code><em>hid_t</em> <code>dataset,</code>
+    <dt><em>H5S_t</em> <code>H5Rget_region(</code><em>H5D_t</em> <code>dataset,</code>
         <em>H5R_type_t</em> <code>type,</code>
-        <em>href_t *</em><code>reference)</code>
+        <em>void *</em><code>reference)</code>
     <dd><code>H5Rget_region</code> creates a copy of dataspace of
         the dataset that is pointed to and defines a selection in 
         the copy which is the location (or region) pointed to.
@@ -195,8 +192,6 @@ The H5I function is also useful outside the context of references.
         type <code>rtype</code> that is stored in the dataset 
         <code>dset</code>.
         <p>
-        <em>This function is not yet implemented.</em>
-        <p>
 
     <dt><em>H5I_type_t</em> <code>H5Iget_type(</code><em>hid_t</em> <code>id)</code>
     <dd>Returns the type of object referred to by the 
@@ -245,8 +240,8 @@ of its raw data and write the dataset to the file.
     hid_t dataset1;
     hid_t datatype, dataspace;
     char buf[128];
-    href_t link;
-    href_t data[10][10];
+    hobj_ref_t link;
+    hobj_ref_t data[10][10];
     int rank;
     size_t dimsf[2];
     int i, j;
@@ -272,7 +267,7 @@ of its raw data and write the dataset to the file.
         for(j=0; j<10; i++)
           {
             sprintf(buf,"/Group/Linked Set %d-%d",i,j);
-            if(H5Rcreate(&link,file1,buf,H5R_REF_OBJ,-1)>0)
+            if(H5Rcreate(&link,file1,buf,H5R_OBJECT,-1)>0)
                 data[i][j]=link;
           } /* end for */