diff options
| author | Dana Robinson <derobins@hdfgroup.org> | 2022-04-13 21:17:29 (GMT) |
|---|---|---|
| committer | Dana Robinson <derobins@hdfgroup.org> | 2022-04-13 21:17:29 (GMT) |
| commit | cabc39c3e197e2591449d2604bfee26465fb60e1 (patch) | |
| tree | d5f39f5f5965584bf9bf49646a2af617adfd3e4e /src/H5Rmodule.h | |
| parent | 7355f4c505092a7a85474b47f18d5206028e2c95 (diff) | |
| parent | ab69f5df770ee3cc6cd6c81d905a5317b894a002 (diff) | |
| download | hdf5-feature/coding_standards.zip hdf5-feature/coding_standards.tar.gz hdf5-feature/coding_standards.tar.bz2 | |
Merge branch 'develop' into feature/coding_standardsfeature/coding_standards
Diffstat (limited to 'src/H5Rmodule.h')
| -rw-r--r-- | src/H5Rmodule.h | 42 |
1 files changed, 35 insertions, 7 deletions
diff --git a/src/H5Rmodule.h b/src/H5Rmodule.h index 678a668..d9ab968 100644 --- a/src/H5Rmodule.h +++ b/src/H5Rmodule.h @@ -5,7 +5,7 @@ * This file is part of HDF5. The full HDF5 copyright notice, including * * terms governing use, modification, and redistribution, is contained in * * the COPYING file, which can be found at the root of the source code * - * distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases. * + * distribution tree, or in https://www.hdfgroup.org/licenses. * * If you do not have access to either file, you may request a copy from * * help@hdfgroup.org. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ @@ -14,16 +14,44 @@ * H5R package. Including this header means that the source file * is part of the H5R package. */ -#ifndef _H5Rmodule_H -#define _H5Rmodule_H +#ifndef H5Rmodule_H +#define H5Rmodule_H /* Define the proper control macros for the generic FUNC_ENTER/LEAVE and error * reporting macros. */ #define H5R_MODULE -#define H5_MY_PKG H5R -#define H5_MY_PKG_ERR H5E_REFERENCE -#define H5_MY_PKG_INIT YES +#define H5_MY_PKG H5R +#define H5_MY_PKG_ERR H5E_REFERENCE -#endif /* _H5Rmodule_H */ +/** + * \defgroup H5R H5R + * + * Use the functions in this module to manage HDF5 references. Referents can + * be HDF5 objects, attributes, and selections on datasets a.k.a. dataset + * regions. + * + * + * <table> + * <tr><th>Create</th><th>Read</th></tr> + * <tr valign="top"> + * <td> + * \snippet{lineno} H5R_examples.c create + * </td> + * <td> + * \snippet{lineno} H5R_examples.c read + * </td> + * <tr><th>Update</th><th>Delete</th></tr> + * <tr valign="top"> + * <td> + * \snippet{lineno} H5R_examples.c update + * </td> + * <td> + * \snippet{lineno} H5R_examples.c delete + * </td> + * </tr> + * </table> + * + */ +#endif /* H5Rmodule_H */ |