summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2020-10-15 22:36:11 (GMT)
committerGitHub <noreply@github.com>2020-10-15 22:36:11 (GMT)
commit2277865c6083e9c34369606dfcd3e551af891978 (patch)
treeee6e55270f8bdcb1feb221ed6866bcba45a83c18
parente146de3feaa761cffd0d1575bd6450f22bbdf09f (diff)
downloadhdf5-2277865c6083e9c34369606dfcd3e551af891978.zip
hdf5-2277865c6083e9c34369606dfcd3e551af891978.tar.gz
hdf5-2277865c6083e9c34369606dfcd3e551af891978.tar.bz2
Mostly whitespace and comment cleanup. (#39)
-rw-r--r--.github/CODEOWNERS10
-rw-r--r--src/H5Aint.c2
-rw-r--r--src/H5Dio.c84
-rw-r--r--src/H5F.c2
-rw-r--r--src/H5FD.c2
-rw-r--r--src/H5FDcore.c6
-rw-r--r--src/H5FDhdfs.c26
-rw-r--r--src/H5FDhdfs.h2
-rw-r--r--src/H5Fint.c4
-rw-r--r--src/H5G.c2
-rw-r--r--src/H5HFtiny.c2
-rw-r--r--src/H5HGcache.c3
-rw-r--r--src/H5I.c2
-rw-r--r--src/H5L.c341
-rw-r--r--src/H5O.c2
-rw-r--r--src/H5PL.c2
16 files changed, 243 insertions, 249 deletions
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
index 97b7428..6061711 100644
--- a/.github/CODEOWNERS
+++ b/.github/CODEOWNERS
@@ -11,11 +11,11 @@
CMakeLists.txt @byrnHDF @derobins
CMakeTests.* @byrnHDF @derobins
-/bin/ @lrknox @derobins @qkoziol
+/bin/ @lrknox @derobins
/c++/ @bmribler @byrnHDF
-/config/ @lrknox @derobins @qkoziol @byrnHDF
+/config/ @lrknox @derobins @byrnHDF
/doc/ @gnuoyd @jrmainzer
@@ -31,11 +31,11 @@ CMakeTests.* @byrnHDF @derobins
/release_docs/ @lrknox @bljhdf @byrnHDF
-/src/ @jhendersonHDF @derobins @fortnern @qkoziol @soumagne @vchoi-hdfgroup @jrmainzer
+/src/ @jhendersonHDF @derobins @fortnern @soumagne @vchoi-hdfgroup @jrmainzer
-/test/ @jhendersonHDF @derobins @fortnern @qkoziol @soumagne @vchoi-hdfgroup @jrmainzer
+/test/ @jhendersonHDF @derobins @fortnern @soumagne @vchoi-hdfgroup @jrmainzer
-/testpar/ @jhendersonHDF @rawarren @jrmainzer @qkoziol
+/testpar/ @jhendersonHDF @rawarren @jrmainzer
/tools/ @byrnHDF @bmribler
diff --git a/src/H5Aint.c b/src/H5Aint.c
index f8ade52..0a3926b 100644
--- a/src/H5Aint.c
+++ b/src/H5Aint.c
@@ -1279,7 +1279,7 @@ done:
/*-------------------------------------------------------------------------
* Function: H5A__exists_by_name
*
- * Purpose: Private version of H5Aexists_by_name
+ * Purpose: Private version of H5Aexists_by_name
*
* Return: TRUE/FALSE/FAIL
*
diff --git a/src/H5Dio.c b/src/H5Dio.c
index f351446..53d27b3 100644
--- a/src/H5Dio.c
+++ b/src/H5Dio.c
@@ -327,8 +327,8 @@ done:
*
* Return: Non-negative on success/Negative on failure
*
- * Programmer: Raymond Lu
- * 30 July 2012
+ * Programmer: Raymond Lu
+ * 30 July 2012
*
*-------------------------------------------------------------------------
*/
@@ -387,15 +387,15 @@ done:
} /* end H5Dwrite_chunk() */
/*-------------------------------------------------------------------------
- * Function: H5D__read
+ * Function: H5D__read
*
- * Purpose: Reads (part of) a DATASET into application memory BUF. See
- * H5Dread() for complete details.
+ * Purpose: Reads (part of) a DATASET into application memory BUF. See
+ * H5Dread() for complete details.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Robb Matzke
- * Thursday, December 4, 1997
+ * Programmer: Robb Matzke
+ * Thursday, December 4, 1997
*
*-------------------------------------------------------------------------
*/
@@ -421,10 +421,10 @@ H5D__read(H5D_t *dataset, hid_t mem_type_id, const H5S_t *mem_space, const H5S_t
/* projected mem space must be discarded at the */
/* end of the function to avoid a memory leak. */
H5D_storage_t store; /* union of EFL and chunk pointer in file space */
- hsize_t nelmts; /* total number of elmts */
+ hsize_t nelmts; /* total number of elmts */
hbool_t io_op_init = FALSE; /* Whether the I/O op has been initialized */
char fake_char; /* Temporary variable for NULL buffer pointers */
- herr_t ret_value = SUCCEED; /* Return value */
+ herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_PACKAGE_TAG(dataset->oloc.addr)
@@ -603,15 +603,15 @@ done:
} /* end H5D__read() */
/*-------------------------------------------------------------------------
- * Function: H5D__write
+ * Function: H5D__write
*
- * Purpose: Writes (part of) a DATASET to a file from application memory
- * BUF. See H5Dwrite() for complete details.
+ * Purpose: Writes (part of) a DATASET to a file from application memory
+ * BUF. See H5Dwrite() for complete details.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Robb Matzke
- * Thursday, December 4, 1997
+ * Programmer: Robb Matzke
+ * Thursday, December 4, 1997
*
*-------------------------------------------------------------------------
*/
@@ -637,10 +637,10 @@ H5D__write(H5D_t *dataset, hid_t mem_type_id, const H5S_t *mem_space, const H5S_
/* projected mem space must be discarded at the */
/* end of the function to avoid a memory leak. */
H5D_storage_t store; /* union of EFL and chunk pointer in file space */
- hsize_t nelmts; /* total number of elmts */
+ hsize_t nelmts; /* total number of elmts */
hbool_t io_op_init = FALSE; /* Whether the I/O op has been initialized */
char fake_char; /* Temporary variable for NULL buffer pointers */
- herr_t ret_value = SUCCEED; /* Return value */
+ herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_PACKAGE_TAG(dataset->oloc.addr)
@@ -838,15 +838,15 @@ done:
} /* end H5D__write() */
/*-------------------------------------------------------------------------
- * Function: H5D__ioinfo_init
+ * Function: H5D__ioinfo_init
*
- * Purpose: Routine for determining correct I/O operations for
+ * Purpose: Routine for determining correct I/O operations for
* each I/O action.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Quincey Koziol
- * Thursday, September 30, 2004
+ * Programmer: Quincey Koziol
+ * Thursday, September 30, 2004
*
*-------------------------------------------------------------------------
*/
@@ -899,15 +899,15 @@ H5D__ioinfo_init(H5D_t *dset, const H5D_type_info_t *type_info, H5D_storage_t *s
} /* end H5D__ioinfo_init() */
/*-------------------------------------------------------------------------
- * Function: H5D__typeinfo_init
+ * Function: H5D__typeinfo_init
*
- * Purpose: Routine for determining correct datatype information for
+ * Purpose: Routine for determining correct datatype information for
* each I/O action.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Quincey Koziol
- * Tuesday, March 4, 2008
+ * Programmer: Quincey Koziol
+ * Tuesday, March 4, 2008
*
*-------------------------------------------------------------------------
*/
@@ -917,7 +917,7 @@ H5D__typeinfo_init(const H5D_t *dset, hid_t mem_type_id, hbool_t do_write, H5D_t
const H5T_t * src_type; /* Source datatype */
const H5T_t * dst_type; /* Destination datatype */
H5Z_data_xform_t *data_transform; /* Data transform info */
- herr_t ret_value = SUCCEED; /* Return value */
+ herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_STATIC
@@ -979,7 +979,7 @@ H5D__typeinfo_init(const H5D_t *dset, hid_t mem_type_id, hbool_t do_write, H5D_t
void * bkgr_buf; /* Background conversion buffer pointer */
size_t max_temp_buf; /* Maximum temporary buffer size */
H5T_bkg_t bkgr_buf_type; /* Background buffer type */
- size_t target_size; /* Desired buffer size */
+ size_t target_size; /* Desired buffer size */
/* Get info from API context */
if (H5CX_get_max_temp_buf(&max_temp_buf) < 0)
@@ -1048,7 +1048,7 @@ H5D__typeinfo_init(const H5D_t *dset, hid_t mem_type_id, hbool_t do_write, H5D_t
type_info->tconv_buf_allocated = TRUE;
} /* end if */
if (type_info->need_bkg && NULL == (type_info->bkg_buf = (uint8_t *)bkgr_buf)) {
- size_t bkg_size; /* Desired background buffer size */
+ size_t bkg_size; /* Desired background buffer size */
/* Compute the background buffer size */
/* (don't try to use buffers smaller than the default size) */
@@ -1072,14 +1072,14 @@ done:
#ifdef H5_HAVE_PARALLEL
/*-------------------------------------------------------------------------
- * Function: H5D__ioinfo_adjust
+ * Function: H5D__ioinfo_adjust
*
- * Purpose: Adjust operation's I/O info for any parallel I/O
+ * Purpose: Adjust operation's I/O info for any parallel I/O
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Quincey Koziol
- * Thursday, March 27, 2008
+ * Programmer: Quincey Koziol
+ * Thursday, March 27, 2008
*
*-------------------------------------------------------------------------
*/
@@ -1087,7 +1087,7 @@ static herr_t
H5D__ioinfo_adjust(H5D_io_info_t *io_info, const H5D_t *dset, const H5S_t *file_space, const H5S_t *mem_space,
const H5D_type_info_t *type_info)
{
- herr_t ret_value = SUCCEED; /* Return value */
+ herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_STATIC
@@ -1225,14 +1225,14 @@ done:
#endif /* H5_HAVE_PARALLEL */
/*-------------------------------------------------------------------------
- * Function: H5D__typeinfo_term
+ * Function: H5D__typeinfo_term
*
- * Purpose: Common logic for terminating a type info object
+ * Purpose: Common logic for terminating a type info object
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Quincey Koziol
- * Thursday, March 6, 2008
+ * Programmer: Quincey Koziol
+ * Thursday, March 6, 2008
*
*-------------------------------------------------------------------------
*/
diff --git a/src/H5F.c b/src/H5F.c
index 8cb5276..55bf382 100644
--- a/src/H5F.c
+++ b/src/H5F.c
@@ -501,7 +501,7 @@ H5Fflush(hid_t object_id, H5F_scope_t scope)
if (!f) {
if (!oloc)
- HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "object is not assocated with a file")
+ HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "object is not associated with a file")
f = oloc->file;
} /* end if */
if (!f)
diff --git a/src/H5FD.c b/src/H5FD.c
index 28a2bea..91d8292 100644
--- a/src/H5FD.c
+++ b/src/H5FD.c
@@ -1542,7 +1542,7 @@ done:
} /* end H5FDtruncate() */
/*-------------------------------------------------------------------------
- * Function: H5FD_truncate
+ * Function: H5FD_truncate
*
* Purpose: Private version of H5FDtruncate()
*
diff --git a/src/H5FDcore.c b/src/H5FDcore.c
index 6043389..c471113 100644
--- a/src/H5FDcore.c
+++ b/src/H5FDcore.c
@@ -276,13 +276,13 @@ H5FD__core_add_dirty_region(H5FD_core_t *file, haddr_t start, haddr_t end)
else {
/* Store the new item endpoint if it's bigger */
item->end = (item->end < end) ? end : item->end;
- } /* end else */
- } /* end if */
+ }
+ }
else {
/* Update the size of the before region */
if (b_item->end < end)
b_item->end = end;
- } /* end else */
+ }
done:
FUNC_LEAVE_NOAPI(ret_value)
diff --git a/src/H5FDhdfs.c b/src/H5FDhdfs.c
index 9323c4f..daebeda 100644
--- a/src/H5FDhdfs.c
+++ b/src/H5FDhdfs.c
@@ -248,8 +248,7 @@ typedef struct {
*
* Programmer: Jacob Smith
*
- ***************************************************************************
- */
+ ***************************************************************************/
typedef struct H5FD_hdfs_t {
H5FD_t pub;
H5FD_hdfs_fapl_t fa;
@@ -374,10 +373,10 @@ done:
hid_t
H5FD_hdfs_init(void)
{
+ hid_t ret_value = H5I_INVALID_HID; /* Return value */
#if HDFS_STATS
unsigned int bin_i;
#endif
- hid_t ret_value = H5I_INVALID_HID; /* Return value */
FUNC_ENTER_NOAPI(H5I_INVALID_HID)
@@ -396,7 +395,7 @@ H5FD_hdfs_init(void)
HDFS_STATS_POW(bin_i, &value)
hdfs_stats_boundaries[bin_i] = value;
- } /* end for */
+ }
#endif
ret_value = H5FD_HDFS_g;
@@ -616,8 +615,7 @@ done:
*
* Return: SUCCEED/FAIL
*
- * Programmer: John Mainzer
- * 9/10/17
+ * Programmer: Jacob Smith 2018
*
*-------------------------------------------------------------------------
*/
@@ -679,9 +677,11 @@ H5Pget_fapl_hdfs(hid_t fapl_id, H5FD_hdfs_fapl_t *fa_out)
if (fa_out == NULL)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "fa_out is NULL")
+
plist = H5P_object_verify(fapl_id, H5P_FILE_ACCESS);
if (plist == NULL)
HGOTO_ERROR(H5E_ARGS, H5E_BADTYPE, FAIL, "not a file access list")
+
if (H5FD_HDFS != H5P_peek_driver(plist))
HGOTO_ERROR(H5E_PLIST, H5E_BADVALUE, FAIL, "incorrect VFL driver")
@@ -830,7 +830,7 @@ hdfs__reset_stats(H5FD_hdfs_t *file)
FUNC_ENTER_STATIC
#if HDFS_DEBUG
- HDprintf("hdfs__reset_stats() called\n");
+ HDfprintf(stdout, "called %s.\n", FUNC);
#endif
if (file == NULL)
@@ -1220,8 +1220,8 @@ done:
static herr_t
H5FD__hdfs_close(H5FD_t *_file)
{
- herr_t ret_value = SUCCEED;
H5FD_hdfs_t *file = (H5FD_hdfs_t *)_file;
+ herr_t ret_value = SUCCEED;
FUNC_ENTER_STATIC
@@ -1262,8 +1262,8 @@ done:
* field-by-field.
*
* Return:
- * + Equivalent: 0
- * + Not Equivalent: -1
+ * Equivalent: 0
+ * Not Equivalent: -1
*
* Programmer: Gerd Herber
* May 2018
@@ -1487,8 +1487,8 @@ H5FD__hdfs_get_eof(const H5FD_t *_file, H5FD_mem_t H5_ATTR_UNUSED type)
static herr_t
H5FD__hdfs_get_handle(H5FD_t *_file, hid_t H5_ATTR_UNUSED fapl, void **file_handle)
{
- herr_t ret_value = SUCCEED;
H5FD_hdfs_t *file = (H5FD_hdfs_t *)_file;
+ herr_t ret_value = SUCCEED;
FUNC_ENTER_STATIC
@@ -1531,9 +1531,9 @@ static herr_t
H5FD__hdfs_read(H5FD_t *_file, H5FD_mem_t H5_ATTR_UNUSED type, hid_t H5_ATTR_UNUSED dxpl_id, haddr_t addr,
size_t size, void *buf)
{
- herr_t ret_value = SUCCEED;
H5FD_hdfs_t *file = (H5FD_hdfs_t *)_file;
size_t filesize = 0;
+ herr_t ret_value = SUCCEED;
#if HDFS_STATS
/* working variables for storing stats */
hdfs_statsbin *bin = NULL;
@@ -1672,7 +1672,7 @@ done:
* No effect on Read-Only S3 file.
*
* Suggestion: remove lock/unlock from class
- * > would result in error at H5FD_[un]lock() (H5FD.c)
+ * would result in error at H5FD_[un]lock() (H5FD.c)
*
* Return:
*
diff --git a/src/H5FDhdfs.h b/src/H5FDhdfs.h
index 5cc578a..5fbc54b 100644
--- a/src/H5FDhdfs.h
+++ b/src/H5FDhdfs.h
@@ -16,7 +16,7 @@
* Programmer: Jacob Smith
* 2018-04-23
*
- * Purpose: The public header file for the hdfs driver.
+ * Purpose: The public header file for the hdfs driver.
*/
#ifndef H5FDhdfs_H
diff --git a/src/H5Fint.c b/src/H5Fint.c
index 9bf67e2..404333a 100644
--- a/src/H5Fint.c
+++ b/src/H5Fint.c
@@ -604,7 +604,7 @@ H5F__get_objects_cb(void *obj_ptr, hid_t obj_id, void *key)
*/
if (olist->max_nobjs > 0 && olist->list_index >= olist->max_nobjs)
HGOTO_DONE(H5_ITER_STOP) /* Indicate that the iterator should stop */
- } /* end if */
+ }
done:
FUNC_LEAVE_NOAPI(ret_value)
@@ -2945,7 +2945,7 @@ H5F__get_file_image(H5F_t *file, void *buf_ptr, size_t buf_len)
*
* While this problem is quire solvable, the required time and
* resources are lacking at present. Hence, for now, we don't
- * allow the get file image operation to be perfomed on files
+ * allow the get file image operation to be performed on files
* opened with the family file driver.
*
* Observe that the following test only looks at the top level
diff --git a/src/H5G.c b/src/H5G.c
index 92b3377..63a5ba0 100644
--- a/src/H5G.c
+++ b/src/H5G.c
@@ -624,7 +624,7 @@ done:
herr_t
H5Gclose(hid_t group_id)
{
- herr_t ret_value = SUCCEED; /* Return value */
+ herr_t ret_value = SUCCEED; /* Return value */
FUNC_ENTER_API(FAIL)
H5TRACE1("e", "i", group_id);
diff --git a/src/H5HFtiny.c b/src/H5HFtiny.c
index 71f6c6d..72be6d6 100644
--- a/src/H5HFtiny.c
+++ b/src/H5HFtiny.c
@@ -34,7 +34,7 @@
#include "H5private.h" /* Generic Functions */
#include "H5Eprivate.h" /* Error handling */
#include "H5HFpkg.h" /* Fractal heaps */
-#include "H5MMprivate.h" /* Memory management */
+#include "H5MMprivate.h" /* Memory management */
/****************/
/* Local Macros */
diff --git a/src/H5HGcache.c b/src/H5HGcache.c
index 5cc2790..757291d 100644
--- a/src/H5HGcache.c
+++ b/src/H5HGcache.c
@@ -292,7 +292,7 @@ H5HG__cache_heap_deserialize(const void *_image, size_t len, void *_udata, hbool
/* Check if we need more room to store heap objects */
if (idx >= heap->nalloc) {
size_t new_alloc; /* New allocation number */
- H5HG_obj_t *new_obj; /* New array of object descriptions */
+ H5HG_obj_t *new_obj; /* New array of object descriptions */
/* Determine the new number of objects to index */
new_alloc = MAX(heap->nalloc * 2, (idx + 1));
@@ -403,7 +403,6 @@ H5HG__cache_heap_image_len(const void *_thing, size_t *image_len)
* H5HG_heap_t, serialize the global heap for writing to file,
* and copy the serialized version into the buffer.
*
- *
* Return: Success: SUCCEED
* Failure: FAIL
*
diff --git a/src/H5I.c b/src/H5I.c
index 32a2276..f17f5bd 100644
--- a/src/H5I.c
+++ b/src/H5I.c
@@ -700,7 +700,7 @@ H5I_register(H5I_type_t type, const void *object, hbool_t app_ref)
hid_t new_id = -1; /* new ID */
hid_t ret_value = H5I_INVALID_HID; /* return value */
- FUNC_ENTER_NOAPI(FAIL)
+ FUNC_ENTER_NOAPI(H5I_INVALID_HID)
/* Check arguments */
if (type <= H5I_BADID || (int)type >= H5I_next_type)
diff --git a/src/H5L.c b/src/H5L.c
index 617cdd2..3654751 100644
--- a/src/H5L.c
+++ b/src/H5L.c
@@ -160,15 +160,15 @@ static size_t H5L_table_used_g = 0;
static H5L_class_t *H5L_table_g = NULL;
/*-------------------------------------------------------------------------
- * Function: H5L_init
+ * Function: H5L_init
*
- * Purpose: Initialize the interface from some other package.
+ * Purpose: Initialize the interface from some other package.
*
- * Return: Success: non-negative
+ * Return: Success: non-negative
*
- * Failure: negative
+ * Failure: negative
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Thursday, July 13, 2006
*
*-------------------------------------------------------------------------
@@ -186,13 +186,13 @@ done:
} /* end H5L_init() */
/*-------------------------------------------------------------------------
- * Function: H5L__init_package
+ * Function: H5L__init_package
*
- * Purpose: Initialize information specific to H5L interface.
+ * Purpose: Initialize information specific to H5L interface.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Tuesday, January 24, 2006
*
*-------------------------------------------------------------------------
@@ -213,13 +213,13 @@ done:
} /* end H5L_init_package() */
/*-------------------------------------------------------------------------
- * Function: H5L_term_package
+ * Function: H5L_term_package
*
- * Purpose: Terminate any resources allocated in H5L__init_package.
+ * Purpose: Terminate any resources allocated in H5L__init_package.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Tuesday, January 24, 2006
*
*-------------------------------------------------------------------------
@@ -259,7 +259,7 @@ H5L_term_package(void)
*
* Return: Non-negative on success/Negative on failure
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Wednesday, March 29, 2006
*
*-------------------------------------------------------------------------
@@ -326,7 +326,7 @@ done:
*
* Return: Non-negative on success/Negative on failure
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Wednesday, March 29, 2006
*
*-------------------------------------------------------------------------
@@ -397,7 +397,7 @@ done:
*
* Return: Non-negative on success/Negative on failure
*
- * Programmer: Robb Matzke
+ * Programmer: Robb Matzke
* Monday, April 6, 1998
*
*-------------------------------------------------------------------------
@@ -456,7 +456,7 @@ done:
*
* Return: Non-negative on success/Negative on failure
*
- * Programmer: Robb Matzke
+ * Programmer: Robb Matzke
* Monday, April 6, 1998
*
*-------------------------------------------------------------------------
@@ -538,7 +538,7 @@ done:
*
* Return: Non-negative on success/Negative on failure
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Tuesday, December 13, 2005
*
*-------------------------------------------------------------------------
@@ -592,7 +592,7 @@ done:
*
* Return: Non-negative on success/Negative on failure
*
- * Programmer: Robb Matzke
+ * Programmer: Robb Matzke
* Monday, April 6, 1998
*
*-------------------------------------------------------------------------
@@ -625,20 +625,20 @@ done:
} /* end H5Ldelete() */
/*-------------------------------------------------------------------------
- * Function: H5Ldelete_by_idx
+ * Function: H5Ldelete_by_idx
*
- * Purpose: Removes the specified link from the group graph and
- * decrements the link count for the object to which it
- * points, according to the order within an index.
+ * Purpose: Removes the specified link from the group graph and
+ * decrements the link count for the object to which it
+ * points, according to the order within an index.
*
- * If the link count reaches zero then all file-space
- * associated with the object will be reclaimed (but if the
- * object is open, then the reclamation of the file space is
- * delayed until all handles to the object are closed).
+ * If the link count reaches zero then all file-space
+ * associated with the object will be reclaimed (but if the
+ * object is open, then the reclamation of the file space is
+ * delayed until all handles to the object are closed).
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Quincey Koziol
+ * Programmer: Quincey Koziol
* Monday, November 13, 2006
*
*-------------------------------------------------------------------------
@@ -676,20 +676,20 @@ done:
} /* end H5Ldelete_by_idx() */
/*-------------------------------------------------------------------------
- * Function: H5Lget_val
+ * Function: H5Lget_val
*
- * Purpose: Returns the link value of a link whose name is NAME. For
+ * Purpose: Returns the link value of a link whose name is NAME. For
* symbolic links, this is the path to which the link points,
* including the null terminator. For user-defined links, it
* is the link buffer.
*
* At most SIZE bytes are copied to the BUF result buffer.
*
- * Return: Success: Non-negative with the link value in BUF.
+ * Return: Success: Non-negative with the link value in BUF.
*
- * Failure: Negative
+ * Failure: Negative
*
- * Programmer: Robb Matzke
+ * Programmer: Robb Matzke
* Monday, April 13, 1998
*
*-------------------------------------------------------------------------
@@ -722,19 +722,19 @@ done:
} /* end H5Lget_val() */
/*-------------------------------------------------------------------------
- * Function: H5Lget_val_by_idx
+ * Function: H5Lget_val_by_idx
*
- * Purpose: Returns the link value of a link, according to the order of
+ * Purpose: Returns the link value of a link, according to the order of
* an index. For symbolic links, this is the path to which the
* link points, including the null terminator. For user-defined
* links, it is the link buffer.
*
* At most SIZE bytes are copied to the BUF result buffer.
*
- * Return: Success: Non-negative with the link value in BUF.
- * Failure: Negative
+ * Return: Success: Non-negative with the link value in BUF.
+ * Failure: Negative
*
- * Programmer: Quincey Koziol
+ * Programmer: Quincey Koziol
* Monday, November 13, 2006
*
*-------------------------------------------------------------------------
@@ -778,7 +778,7 @@ done:
*
* Return: Success: TRUE/FALSE/FAIL
*
- * Programmer: Quincey Koziol
+ * Programmer: Quincey Koziol
* Friday, March 16, 2007
*
*-------------------------------------------------------------------------
@@ -820,7 +820,7 @@ done:
* Return: Success: Non-negative with information in LINFO
* Failure: Negative
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Wednesday, June 21, 2006
*
*-------------------------------------------------------------------------
@@ -861,7 +861,7 @@ done:
* Return: Success: Non-negative with information in LINFO
* Failure: Negative
*
- * Programmer: Quincey Koziol
+ * Programmer: Quincey Koziol
* Monday, November 6, 2006
*
*-------------------------------------------------------------------------
@@ -899,9 +899,9 @@ done:
} /* end H5Lget_info_by_idx() */
/*-------------------------------------------------------------------------
- * Function: H5Lregister
+ * Function: H5Lregister
*
- * Purpose: Registers a class of user-defined links, or changes the
+ * Purpose: Registers a class of user-defined links, or changes the
* behavior of an existing class.
*
* The link class passed in will override any existing link
@@ -910,9 +910,9 @@ done:
* H5L_LINK_CLASS_T_VERS), a link class ID, and a traversal
* function.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Monday, July 10, 2006
*
*-------------------------------------------------------------------------
@@ -953,16 +953,16 @@ done:
} /* end H5Lregister() */
/*-------------------------------------------------------------------------
- * Function: H5Lunregister
+ * Function: H5Lunregister
*
- * Purpose: Unregisters a class of user-defined links, preventing them
+ * Purpose: Unregisters a class of user-defined links, preventing them
* from being traversed, queried, moved, etc.
*
* A link class can be re-registered using H5Lregister().
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Monday, July 10, 2006
*
*-------------------------------------------------------------------------
@@ -997,7 +997,7 @@ done:
* FALSE if it is unregistered
* FAIL on error (if the class is not a valid UD class ID)
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Monday, July 10, 2006
*
*-------------------------------------------------------------------------
@@ -1039,7 +1039,7 @@ done:
*
* Failure: -1
*
- * Programmer: Quincey Koziol
+ * Programmer: Quincey Koziol
* Saturday, November 11, 2006
*
*-------------------------------------------------------------------------
@@ -1201,8 +1201,8 @@ done:
* library, or the negative value returned by one
* of the operators.
*
- * Programmer: Quincey Koziol
- * November 24 2007
+ * Programmer: Quincey Koziol
+ * November 24 2007
*
*-------------------------------------------------------------------------
*/
@@ -1304,16 +1304,16 @@ done:
*/
/*-------------------------------------------------------------------------
- * Function: H5L_find_class_idx
+ * Function: H5L_find_class_idx
*
- * Purpose: Given a link class ID, return the offset in the global array
+ * Purpose: Given a link class ID, return the offset in the global array
* that holds all the registered link classes.
*
- * Return: Success: Non-negative index of entry in global
+ * Return: Success: Non-negative index of entry in global
* link class table.
- * Failure: Negative
+ * Failure: Negative
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Monday, July 10, 2006
*
*-------------------------------------------------------------------------
@@ -1335,15 +1335,15 @@ done:
} /* end H5L_find_class_idx */
/*-------------------------------------------------------------------------
- * Function: H5L_find_class
+ * Function: H5L_find_class
*
- * Purpose: Given a link class ID return a pointer to a global struct that
- * defines the link class.
+ * Purpose: Given a link class ID return a pointer to a global struct that
+ * defines the link class.
*
- * Return: Success: Ptr to entry in global link class table.
- * Failure: NULL
+ * Return: Success: Ptr to entry in global link class table.
+ * Failure: NULL
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Monday, July 10, 2006
*
*-------------------------------------------------------------------------
@@ -1368,16 +1368,16 @@ done:
} /* end H5L_find_class */
/*-------------------------------------------------------------------------
- * Function: H5L_register
+ * Function: H5L_register
*
- * Purpose: Registers a class of user-defined links, or changes the
+ * Purpose: Registers a class of user-defined links, or changes the
* behavior of an existing class.
*
* See H5Lregister for full documentation.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Monday, July 10, 2006
*
*-------------------------------------------------------------------------
@@ -1421,15 +1421,15 @@ done:
} /* end H5L_register */
/*-------------------------------------------------------------------------
- * Function: H5L_unregister
+ * Function: H5L_unregister
*
- * Purpose: Unregisters a class of user-defined links.
+ * Purpose: Unregisters a class of user-defined links.
*
* See H5Lunregister for full documentation.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Monday, July 10, 2006
*
*-------------------------------------------------------------------------
@@ -1463,14 +1463,14 @@ done:
} /* end H5L_unregister() */
/*-------------------------------------------------------------------------
- * Function: H5L_link
+ * Function: H5L_link
*
- * Purpose: Creates a link from OBJ_ID to CUR_NAME. See H5Olink() for
- * full documentation.
+ * Purpose: Creates a link from OBJ_ID to CUR_NAME. See H5Olink() for
+ * full documentation.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Tuesday, December 13, 2005
*
*-------------------------------------------------------------------------
@@ -1506,13 +1506,13 @@ done:
} /* end H5L_link() */
/*-------------------------------------------------------------------------
- * Function: H5L_link_object
+ * Function: H5L_link_object
*
- * Purpose: Creates a new object and a link to it.
+ * Purpose: Creates a new object and a link to it.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Quincey Koziol
+ * Programmer: Quincey Koziol
* Monday, April 9, 2007
*
*-------------------------------------------------------------------------
@@ -1547,13 +1547,13 @@ done:
} /* end H5L_link_object() */
/*-------------------------------------------------------------------------
- * Function: H5L__link_cb
+ * Function: H5L__link_cb
*
- * Purpose: Callback for creating a link to an object.
+ * Purpose: Callback for creating a link to an object.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Quincey Koziol
+ * Programmer: Quincey Koziol
* Monday, September 19, 2005
*
*-------------------------------------------------------------------------
@@ -1793,13 +1793,13 @@ done:
} /* end H5L__create_real() */
/*-------------------------------------------------------------------------
- * Function: H5L_create_hard
+ * Function: H5L_create_hard
*
- * Purpose: Creates a hard link from NEW_NAME to CUR_NAME.
+ * Purpose: Creates a hard link from NEW_NAME to CUR_NAME.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Robb Matzke
+ * Programmer: Robb Matzke
* Monday, April 6, 1998
*
*-------------------------------------------------------------------------
@@ -1871,7 +1871,7 @@ done:
*
* Return: SUCCEED/FAIL
*
- * Programmer: Robb Matzke
+ * Programmer: Robb Matzke
* Monday, April 6, 1998
*
*-------------------------------------------------------------------------
@@ -1911,14 +1911,14 @@ done:
} /* end H5L_create_soft() */
/*-------------------------------------------------------------------------
- * Function: H5L__create_ud
+ * Function: H5L__create_ud
*
- * Purpose: Creates a user-defined link. See H5Lcreate_ud for
+ * Purpose: Creates a user-defined link. See H5Lcreate_ud for
* full documentation.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Friday, May 19, 2006
*
*-------------------------------------------------------------------------
@@ -1968,13 +1968,13 @@ done:
} /* end H5L__create_ud() */
/*-------------------------------------------------------------------------
- * Function: H5L__get_val_real
+ * Function: H5L__get_val_real
*
- * Purpose: Retrieve link value from a link object
+ * Purpose: Retrieve link value from a link object
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Quincey Koziol
+ * Programmer: Quincey Koziol
* Monday, November 13 2006
*
*-------------------------------------------------------------------------
@@ -2023,13 +2023,13 @@ done:
} /* end H5L__get_val_real() */
/*-------------------------------------------------------------------------
- * Function: H5L__get_val_cb
+ * Function: H5L__get_val_cb
*
- * Purpose: Callback for retrieving link value or udata.
+ * Purpose: Callback for retrieving link value or udata.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Quincey Koziol
+ * Programmer: Quincey Koziol
* Tuesday, September 20, 2005
*
*-------------------------------------------------------------------------
@@ -2060,20 +2060,20 @@ done:
} /* end H5L__get_val_cb() */
/*-------------------------------------------------------------------------
- * Function: H5L_get_val
+ * Function: H5L_get_val
*
- * Purpose: Returns the value of a symbolic link or the udata for a
+ * Purpose: Returns the value of a symbolic link or the udata for a
* user-defined link.
*
- * Return: Success: Non-negative, with at most SIZE bytes of the
- * link value copied into the BUF buffer. If the
- * link value is larger than SIZE characters
- * counting the null terminator then the BUF
- * result will not be null terminated.
+ * Return: Success: Non-negative, with at most SIZE bytes of the
+ * link value copied into the BUF buffer. If the
+ * link value is larger than SIZE characters
+ * counting the null terminator then the BUF
+ * result will not be null terminated.
*
- * Failure: Negative
+ * Failure: Negative
*
- * Programmer: Robb Matzke
+ * Programmer: Robb Matzke
* Monday, April 13, 1998
*
*-------------------------------------------------------------------------
@@ -2103,14 +2103,14 @@ done:
} /* H5L_get_val() */
/*-------------------------------------------------------------------------
- * Function: H5L__get_val_by_idx_cb
+ * Function: H5L__get_val_by_idx_cb
*
- * Purpose: Callback for retrieving a link's value according to an
+ * Purpose: Callback for retrieving a link's value according to an
* index's order.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Quincey Koziol
+ * Programmer: Quincey Koziol
* Monday, November 13 2006
*
*-------------------------------------------------------------------------
@@ -2194,14 +2194,14 @@ done:
} /* end H5L__get_val_by_idx() */
/*-------------------------------------------------------------------------
- * Function: H5L__delete_cb
+ * Function: H5L__delete_cb
*
- * Purpose: Callback for deleting a link. This routine
+ * Purpose: Callback for deleting a link. This routine
* actually deletes the link
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Quincey Koziol
+ * Programmer: Quincey Koziol
* Monday, September 19, 2005
*
*-------------------------------------------------------------------------
@@ -2243,13 +2243,13 @@ done:
} /* end H5L__delete_cb() */
/*-------------------------------------------------------------------------
- * Function: H5L_delete
+ * Function: H5L_delete
*
- * Purpose: Delete a link from a group.
+ * Purpose: Delete a link from a group.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Robb Matzke
+ * Programmer: Robb Matzke
* Thursday, September 17, 1998
*
*-------------------------------------------------------------------------
@@ -2284,13 +2284,13 @@ done:
} /* end H5L_delete() */
/*-------------------------------------------------------------------------
- * Function: H5L__delete_by_idx_cb
+ * Function: H5L__delete_by_idx_cb
*
- * Purpose: Callback for removing a link according to an index's order.
+ * Purpose: Callback for removing a link according to an index's order.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Quincey Koziol
+ * Programmer: Quincey Koziol
* Monday, November 13 2006
*
*-------------------------------------------------------------------------
@@ -2363,15 +2363,15 @@ done:
} /* end H5L__delete_by_idx() */
/*-------------------------------------------------------------------------
- * Function: H5L__move_dest_cb
+ * Function: H5L__move_dest_cb
*
- * Purpose: Second callback for moving and renaming an object. This routine
+ * Purpose: Second callback for moving and renaming an object. This routine
* inserts a new link into the group returned by the traversal.
* It is called by H5L__move_cb.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Monday, April 3, 2006
*
*-------------------------------------------------------------------------
@@ -2475,15 +2475,15 @@ done:
} /* end H5L__move_dest_cb() */
/*-------------------------------------------------------------------------
- * Function: H5L__move_cb
+ * Function: H5L__move_cb
*
- * Purpose: Callback for moving and renaming an object. This routine
+ * Purpose: Callback for moving and renaming an object. This routine
* replaces the names of open objects with the moved object
* in the path
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Friday, April 3, 2006
*
*-------------------------------------------------------------------------
@@ -2589,9 +2589,9 @@ done:
} /* end H5L__move_cb() */
/*-------------------------------------------------------------------------
- * Function: H5L_move
+ * Function: H5L_move
*
- * Purpose: Atomically move or copy a link.
+ * Purpose: Atomically move or copy a link.
*
* Creates a copy of a link in a new destination with a new name.
* SRC_LOC and SRC_NAME together define the link's original
@@ -2601,9 +2601,9 @@ done:
* If copy_flag is FALSE, the original link is removed
* (effectively moving the link).
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Monday, May 1, 2006
*
*-------------------------------------------------------------------------
@@ -2669,14 +2669,14 @@ done:
} /* end H5L_move() */
/*-------------------------------------------------------------------------
- * Function: H5L__exists_final_cb
+ * Function: H5L__exists_final_cb
*
- * Purpose: Callback for checking whether a link exists, as the final
+ * Purpose: Callback for checking whether a link exists, as the final
* component of a path
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Quincey Koziol
+ * Programmer: Quincey Koziol
* Friday, March 16 2007
*
*-------------------------------------------------------------------------
@@ -2701,14 +2701,14 @@ H5L__exists_final_cb(H5G_loc_t H5_ATTR_UNUSED *grp_loc /*in*/, const char H5_ATT
} /* end H5L__exists_final_cb() */
/*-------------------------------------------------------------------------
- * Function: H5L__exists_inter_cb
+ * Function: H5L__exists_inter_cb
*
- * Purpose: Callback for checking whether a link exists, as an intermediate
+ * Purpose: Callback for checking whether a link exists, as an intermediate
* component of a path
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Quincey Koziol
+ * Programmer: Quincey Koziol
* Thursday, December 31 2015
*
*-------------------------------------------------------------------------
@@ -2826,16 +2826,13 @@ done:
} /* H5L_exists_tolerant() */
/*-------------------------------------------------------------------------
- * Function: H5L__exists
- *
- * Purpose: Returns whether a link exists in a group
+ * Function: H5L__exists
*
- * Note: Same as H5L_exists_tolerant, except that missing links are reported
- * as failures
+ * Purpose: Returns whether a link exists in a group
*
- * Return: Non-negative (TRUE/FALSE) on success/Negative on failure
+ * Return: Non-negative (TRUE/FALSE) on success/Negative on failure
*
- * Programmer: Quincey Koziol
+ * Programmer: Quincey Koziol
* Friday, March 16 2007
*
*-------------------------------------------------------------------------
@@ -2865,13 +2862,13 @@ done:
} /* H5L__exists() */
/*-------------------------------------------------------------------------
- * Function: H5L__get_info_cb
+ * Function: H5L__get_info_cb
*
- * Purpose: Callback for retrieving a link's metadata
+ * Purpose: Callback for retrieving a link's metadata
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Monday, April 17 2006
*
*-------------------------------------------------------------------------
@@ -2909,7 +2906,7 @@ done:
*
* Return: SUCCEED/FAIL
*
- * Programmer: James Laird
+ * Programmer: James Laird
* Monday, April 17 2006
*
*-------------------------------------------------------------------------
@@ -2933,14 +2930,14 @@ done:
} /* H5L_get_info() */
/*-------------------------------------------------------------------------
- * Function: H5L__get_info_by_idx_cb
+ * Function: H5L__get_info_by_idx_cb
*
- * Purpose: Callback for retrieving a link's metadata according to an
+ * Purpose: Callback for retrieving a link's metadata according to an
* index's order.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Quincey Koziol
+ * Programmer: Quincey Koziol
* Monday, November 6 2006
*
*-------------------------------------------------------------------------
@@ -3021,14 +3018,14 @@ done:
} /* end H5L__get_info_by_idx() */
/*-------------------------------------------------------------------------
- * Function: H5L__get_name_by_idx_cb
+ * Function: H5L__get_name_by_idx_cb
*
- * Purpose: Callback for retrieving a link's name according to an
+ * Purpose: Callback for retrieving a link's name according to an
* index's order.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Quincey Koziol
+ * Programmer: Quincey Koziol
* Saturday, November 11 2006
*
*-------------------------------------------------------------------------
@@ -3104,15 +3101,15 @@ done:
} /* end H5L__get_name_by_idx() */
/*-------------------------------------------------------------------------
- * Function: H5L__link_copy_file
+ * Function: H5L__link_copy_file
*
* Purpose: Copy a link and the object it points to from one file to
* another.
*
- * Return: Non-negative on success/Negative on failure
+ * Return: Non-negative on success/Negative on failure
*
- * Programmer: Quincey Koziol
- * Sep 29 2006
+ * Programmer: Quincey Koziol
+ * Sep 29 2006
*
*-------------------------------------------------------------------------
*/
diff --git a/src/H5O.c b/src/H5O.c
index ea35646..06b96f8 100644
--- a/src/H5O.c
+++ b/src/H5O.c
@@ -212,7 +212,7 @@ H5Oopen_by_addr(hid_t loc_id, haddr_t addr)
H5G_loc_t loc; /* Location within file */
hid_t ret_value = H5I_INVALID_HID; /* Return value */
- FUNC_ENTER_API(FAIL)
+ FUNC_ENTER_API(H5I_INVALID_HID)
H5TRACE2("i", "ia", loc_id, addr);
/* Check args */
diff --git a/src/H5PL.c b/src/H5PL.c
index c3c9120..de34f0a 100644
--- a/src/H5PL.c
+++ b/src/H5PL.c
@@ -275,8 +275,6 @@ done:
* Return: Success: Non-negative
* Failture: Negative
*
- * Return: Non-negative or success.
- *
*-------------------------------------------------------------------------
*/
herr_t