summaryrefslogtreecommitdiffstats
path: root/src/H5CX.c
diff options
context:
space:
mode:
authorQuincey Koziol <koziol@hdfgroup.org>2018-03-29 02:36:21 (GMT)
committerQuincey Koziol <koziol@hdfgroup.org>2018-03-29 02:36:21 (GMT)
commit174439c95b82b2ec94fca61344a9ef6b78c03b85 (patch)
tree4aadb42936bfadb0b0fb46d87146521318617418 /src/H5CX.c
parentc975f49984d5da0ba5a9cd4fb3f8918bb49b595c (diff)
downloadhdf5-174439c95b82b2ec94fca61344a9ef6b78c03b85.zip
hdf5-174439c95b82b2ec94fca61344a9ef6b78c03b85.tar.gz
hdf5-174439c95b82b2ec94fca61344a9ef6b78c03b85.tar.bz2
Expanded comments abuot H5CX_t fields.
Diffstat (limited to 'src/H5CX.c')
-rw-r--r--src/H5CX.c26
1 files changed, 14 insertions, 12 deletions
diff --git a/src/H5CX.c b/src/H5CX.c
index f335e38..135451c 100644
--- a/src/H5CX.c
+++ b/src/H5CX.c
@@ -156,24 +156,26 @@
*
* - Internal fields, used and set only within the library, for managing the
* operation under way. These do not correspond to properties in the
- * DXPL or LAPL.
+ * DXPL or LAPL and can have any name.
*
- * - Cached properties, which are not returned to the application, for managing
+ * - Cached fields, which are not returned to the application, for managing
* the operation under way. These correspond to properties in the DXPL
* or LAPL, and are retrieved either from the (global) cache for a
* default property list, or from the corresponding property in the
* application's (non-default) property list. Getting / setting these
* properties within the library does _not_ affect the application's
* property list. Note that the naming of these fields, <foo> and
- * <foo>_valid, is important for the macros to work properly.
- *
- * - "Set" properties that are returned to the application, mainly for sending
- * out "introspection" information ("Why did collective I/O get broken?",
- * "Which filters are set on the chunk I just directly read in?", etc)
- * Setting these values will cause the corresponding property in the
- * property list to be set when the API context is popped, when
- * returning from the API routine. Note that the naming of these fields,
- * <foo> and <foo>_set, is important for the macros to work properly.
+ * <foo>_valid, is important for the H5CX_RETRIEVE_PROP_VALID ahd
+ * H5CX_RETRIEVE_PROP_VALID_SET macros to work properly.
+ *
+ * - "Return-only"" properties that are returned to the application, mainly
+ * for sending out "introspection" information ("Why did collective I/O
+ * get broken for this operation?", "Which filters are set on the chunk I
+ * just directly read in?", etc) Setting these fields will cause the
+ * corresponding property in the property list to be set when the API
+ * context is popped, when returning from the API routine. Note that the
+ * naming of these fields, <foo> and <foo>_set, is important for the
+* H5CX_TEST_SET_PROP and H5CX_SET_PROP macros to work properly.
*/
typedef struct H5CX_t {
/* DXPL */
@@ -246,7 +248,7 @@ typedef struct H5CX_t {
H5T_conv_cb_t dt_conv_cb; /* Datatype conversion struct (H5D_XFER_CONV_CB_NAME) */
hbool_t dt_conv_cb_valid; /* Whether datatype conversion struct is valid */
- /* Set DXPL properties to return to application */
+ /* Return-only DXPL properties to return to application */
uint32_t dcr_filters; /* Direct chunk read filter flags (H5D_XFER_DIRECT_CHUNK_READ_FILTERS_NAME) */
hbool_t dcr_filters_set; /* Whether direct chunk read filter flags are set */
#ifdef H5_HAVE_PARALLEL