diff options
| author | Dana Robinson <derobins@hdfgroup.org> | 2016-09-23 05:18:11 (GMT) |
|---|---|---|
| committer | Dana Robinson <derobins@hdfgroup.org> | 2016-09-23 05:18:11 (GMT) |
| commit | 430ff33b5c6e5e020afae7f150b8442c223353ca (patch) | |
| tree | 28345daa772fe706a413066f5ba590e10e25a99a | |
| parent | 5ac0b328c8de74c11afb7aad7a5305389c70adaa (diff) | |
| download | hdf5-430ff33b5c6e5e020afae7f150b8442c223353ca.zip hdf5-430ff33b5c6e5e020afae7f150b8442c223353ca.tar.gz hdf5-430ff33b5c6e5e020afae7f150b8442c223353ca.tar.bz2 | |
Added "Purpose:" information to the API call comments for the
new functions.
| -rw-r--r-- | src/H5Pfapl.c | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/src/H5Pfapl.c b/src/H5Pfapl.c index d96bd54..8801061 100644 --- a/src/H5Pfapl.c +++ b/src/H5Pfapl.c @@ -3621,7 +3621,13 @@ done: /*------------------------------------------------------------------------- * Function: H5Pset_evict_on_close * - * Purpose: + * Purpose: Sets the evict_on_close property value. + * + * When this property is set, closing an HDF5 object will + * cause the object's metadata cache entries to be flushed + * and evicted from the cache. + * + * Currently only implemented for datasets. * * Return: SUCCEED/FAIL * @@ -3659,7 +3665,13 @@ done: /*------------------------------------------------------------------------- * Function: H5Pget_evict_on_close * - * Purpose: + * Purpose: Gets the evict_on_close property value. + * + * When this property is set, closing an HDF5 object will + * cause the object's metadata cache entries to be flushed + * and evicted from the cache. + * + * Currently only implemented for datasets. * * Return: SUCCEED/FAIL * |