[svn-r20241] Corrected an error in the comments for H5Oget_comment(_by_name) and H5G_loc_get_comment_cb: the return

value is the size of the comment excluding NULL terminator.

No test is needed.
This commit is contained in:
Raymond Lu 2011-03-14 11:52:52 -05:00
parent ac3b230f0b
commit 9cfc4f8af3
2 changed files with 3 additions and 3 deletions

View File

@ -947,7 +947,7 @@ done:
* Purpose: Retrieve the information for an object from a group location * Purpose: Retrieve the information for an object from a group location
* and path to that object * and path to that object
* *
* Return: Success: Number of bytes in the comment including the * Return: Success: Number of bytes in the comment excluding the
* null terminator. Zero if the object has no * null terminator. Zero if the object has no
* comment. * comment.
* *

View File

@ -822,7 +822,7 @@ done:
* *
* Purpose: Retrieve comment for an object. * Purpose: Retrieve comment for an object.
* *
* Return: Success: Number of bytes in the comment including the * Return: Success: Number of bytes in the comment excluding the
* null terminator. Zero if the object has no * null terminator. Zero if the object has no
* comment. * comment.
* *
@ -860,7 +860,7 @@ done:
* *
* Purpose: Retrieve comment for an object. * Purpose: Retrieve comment for an object.
* *
* Return: Success: Number of bytes in the comment including the * Return: Success: Number of bytes in the comment excluding the
* null terminator. Zero if the object has no * null terminator. Zero if the object has no
* comment. * comment.
* *