summaryrefslogtreecommitdiffstats
path: root/src/H5HG.c
diff options
context:
space:
mode:
authorQuincey Koziol <koziol@hdfgroup.org>1998-10-26 21:18:54 (GMT)
committerQuincey Koziol <koziol@hdfgroup.org>1998-10-26 21:18:54 (GMT)
commit69d3cf72b3498e4f6ee95425881cf227f7f71c93 (patch)
tree686a04bfbdced05835ec3d075a367c95c96cab3f /src/H5HG.c
parent4d5f1b72de9f2439904975da411dea4f8095fe7b (diff)
downloadhdf5-69d3cf72b3498e4f6ee95425881cf227f7f71c93.zip
hdf5-69d3cf72b3498e4f6ee95425881cf227f7f71c93.tar.gz
hdf5-69d3cf72b3498e4f6ee95425881cf227f7f71c93.tar.bz2
[svn-r797] Changed comments from returning "SUCCEED/FAIL" to "non-negative/negative"
and also fixed a few more explicit checks against FAIL.
Diffstat (limited to 'src/H5HG.c')
-rw-r--r--src/H5HG.c20
1 files changed, 7 insertions, 13 deletions
diff --git a/src/H5HG.c b/src/H5HG.c
index f3e73bf..2cf3c25 100644
--- a/src/H5HG.c
+++ b/src/H5HG.c
@@ -349,9 +349,7 @@ H5HG_load (H5F_t *f, const haddr_t *addr, const void __unused__ *udata1,
* Purpose: Flushes a global heap collection from memory to disk if it's
* dirty. Optionally deletes teh heap from memory.
*
- * Return: Success: SUCCEED
- *
- * Failure: FAIL
+ * Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Friday, March 27, 1998
@@ -411,7 +409,7 @@ H5HG_flush (H5F_t *f, hbool_t destroy, const haddr_t *addr, H5HG_heap_t *heap)
*
* Return: Success: The heap object ID of the new object.
*
- * Failure: FAIL
+ * Failure: Negative
*
* Programmer: Robb Matzke
* Friday, March 27, 1998
@@ -505,10 +503,10 @@ H5HG_alloc (H5F_t *f, H5HG_heap_t *heap, int cwfsno, size_t size)
* It is legal to push a zero-byte object onto the heap to get
* the reference count features of heap objects.
*
- * Return: Success: SUCCEED, and a heap object handle returned
+ * Return: Success: Non-negative, and a heap object handle returned
* through the HOBJ pointer.
*
- * Failure: FAIL
+ * Failure: Negative
*
* Programmer: Robb Matzke
* Friday, March 27, 1998
@@ -726,7 +724,7 @@ H5HG_read (H5F_t *f, H5HG_t *hobj, void *object/*out*/)
*
* Return: Success: Number of links present after the adjustment.
*
- * Failure: FAIL
+ * Failure: Negative
*
* Programmer: Robb Matzke
* Monday, March 30, 1998
@@ -776,9 +774,7 @@ H5HG_link (H5F_t *f, H5HG_t *hobj, intn adjust)
*
* Purpose: Removes the specified object from the global heap.
*
- * Return: Success: SUCCEED
- *
- * Failure: FAIL
+ * Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* Monday, March 30, 1998
@@ -878,9 +874,7 @@ H5HG_remove (H5F_t *f, H5HG_t *hobj)
*
* Purpose: Prints debugging information about a global heap collection.
*
- * Return: Success: SUCCEED
- *
- * Failure: FAIL
+ * Return: Non-negative on success/Negative on failure
*
* Programmer: Robb Matzke
* matzke@llnl.gov