From 2e588eef3fe7e7108168d095d385502fd8e41b9d Mon Sep 17 00:00:00 2001
From: Frank Baker <fbaker@hdfgroup.org>
Date: Tue, 25 May 2004 12:36:59 -0500
Subject: [svn-r8573] Purpose:     Bugfixes in H5Gset_comment,
 h5gget_comment_f, and h5gset_comment_f.     (Follow-on to the H5Gget_comment
 bugfix of last week.)

Description:
    Changed C parameter descriptions to indicate the following:
        'loc_id' can be file, group, dataset, or named datatype.
        'name' can be '.' if 'loc_id' fully describes the object.
        'name' is ignored if 'loc_id' is a dataset or named datatype.
    Modified h5gget_comment_f and h5gset_comment_f notes accordingly.
    Copy edits in H5Gget/set_comment and h5gget/set_comment_f.

Platforms tested:
    Safari
---
 doc/html/RM_H5G.html | 44 ++++++++++++++++++++++++++++----------------
 1 file changed, 28 insertions(+), 16 deletions(-)

diff --git a/doc/html/RM_H5G.html b/doc/html/RM_H5G.html
index edd91a2..717667e 100644
--- a/doc/html/RM_H5G.html
+++ b/doc/html/RM_H5G.html
@@ -345,7 +345,8 @@ END SUBROUTINE h5gcreate_f
         The comment is returned in the buffer <code>comment</code>.
         <p>
         At most <code>bufsize</code> characters, including a null 
-        terminator, are copied.  The result is not null terminated 
+        terminator, are returned in <code>comment</code>.  
+        The returned value is not null terminated 
         if the comment is longer than the supplied buffer.  
         <p>
         If an object does not have a comment, the empty string 
@@ -354,24 +355,24 @@ END SUBROUTINE h5gcreate_f
     <ul><table>
       <tr>
         <td valign="top"><em>hid_t</em> <code>loc_id</code></td>
-        <td valign="top">IN: Identifier of the file or group.</td></tr>
+        <td valign="top">IN: Identifier of the file, group, dataset, or 
+            named datatype.</td></tr>
       <tr>
         <td valign="top"><em>const&nbsp;char&nbsp;*</em><code>name&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
         <td valign="top">IN: Name of the object in <code>loc_id</code> whose 
             comment is to be retrieved.
             <br>
             <code>name</code> can be '.' (dot) if <code>loc_id</code> 
-            fully specifies the object for which the  associated comment 
+            fully specifies the object for which the associated comment 
             is to be retrieved.
             <br>
             <code>name</code> is ignored if <code>loc_id</code> 
             is a dataset or named datatype.
-
             </td></tr>
       <tr>
         <td valign="top"><em>size_t</em> <code>bufsize</code></td>
-        <td valign="top">IN: Anticipated size of the buffer required to hold 
-            <code>comment</code>.</td></tr>
+        <td valign="top">IN: Anticipated required size of the  
+            <code>comment</code> buffer.</td></tr>
       <tr>
         <td valign="top"><em>char *</em><code>comment</code></td>
         <td valign="top">OUT: The comment.</td></tr>
@@ -386,10 +387,10 @@ END SUBROUTINE h5gcreate_f
     <pre>
 SUBROUTINE h5gget_comment_f(loc_id, name, size, buffer, hdferr)
   IMPLICIT NONE
-  INTEGER(HID_T), INTENT(IN) :: loc_id         ! File or group identifier
+  INTEGER(HID_T), INTENT(IN) :: loc_id         ! File, group, dataset, or
+                                               ! named datatype identifier  
   CHARACTER(LEN=*), INTENT(IN) :: name         ! Name of the object link 
-  CHARACTER(LEN=size), INTENT(OUT) :: buffer   ! Buffer to hold a
-                                               ! comment  
+  CHARACTER(LEN=size), INTENT(OUT) :: buffer   ! Buffer to hold the comment
   INTEGER, INTENT(OUT) :: hdferr               ! Error code 
                                                ! 0 on success and -1 on failure
 END SUBROUTINE h5gget_comment_f
@@ -1305,8 +1306,9 @@ END SUBROUTINE h5gopen_f
   <dt><strong>Purpose:</strong>
     <dd>Sets comment for specified object.
   <dt><strong>Description:</strong>
-    <dd><code>H5Gset_comment</code> sets the comment for the the
-        object <code>name</code> to <code>comment</code>.
+    <dd><code>H5Gset_comment</code> sets the comment for the 
+        object specified by <code>loc_id</code> and <code>name</code> 
+        to <code>comment</code>.
         Any previously existing comment is overwritten.
         <p>
         If <code>comment</code> is the empty string or a 
@@ -1316,16 +1318,25 @@ END SUBROUTINE h5gopen_f
         ASCII strings.
         <p>
         Comments can be attached to any object that has an object header, 
-        e.g., data sets, groups, named data types, and data spaces, but 
+        e.g., datasets, groups, named datatypes, and dataspaces, but 
         not symbolic links.
   <dt><strong>Parameters:</strong>
     <ul><table>
       <tr>
 	    <td valign="top"><em>hid_t</em> <code>loc_id</code></td>
-        <td valign="top">IN: Identifier of the file or group.</td></tr>
+        <td valign="top">IN: Identifier of the file, group, dataset, 
+            or named datatype.</td></tr>
       <tr>
 	    <td valign="top"><em>const char *</em><code>name</code></td>
-        <td valign="top">IN: Name of the object whose comment is to be set or reset.</td></tr>
+        <td valign="top">IN: Name of the object whose comment is to be 
+            set or reset.
+            <br>
+            <code>name</code> can be '.' (dot) if <code>loc_id</code> 
+            fully specifies the object for which the comment is to be set.
+            <br>
+            <code>name</code> is ignored if <code>loc_id</code> 
+            is a dataset or named datatype.
+	    </td></tr>
       <tr>
 	    <td valign="top"><em>const&nbsp;char&nbsp;*</em><code>comment&nbsp;&nbsp;&nbsp;&nbsp;</code></td>
         <td valign="top">IN: The new comment.</td></tr>
@@ -1338,7 +1349,8 @@ END SUBROUTINE h5gopen_f
 	<pre>
 SUBROUTINE h5gset_comment_f(loc_id, name, comment, hdferr)
   IMPLICIT NONE
-  INTEGER(HID_T), INTENT(IN) :: loc_id      ! File or group identifier
+  INTEGER(HID_T), INTENT(IN) :: loc_id      ! File, group, dataset, or 
+                                            ! named datatype identifier
   CHARACTER(LEN=*), INTENT(IN) :: name      ! Name of object 
   CHARACTER(LEN=*), INTENT(IN) :: comment   ! Comment for the object 
   INTEGER, INTENT(OUT) :: hdferr            ! Error code 
@@ -1463,7 +1475,7 @@ And in this document, the
 Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0
 </address><!-- #EndLibraryItem --><SCRIPT LANGUAGE="JAVASCRIPT">
 <!--
-document.writeln("Last modified: 21 May 2004");
+document.writeln("Last modified: 25 May 2004");
 -->
 </SCRIPT>
  
-- 
cgit v0.12