diff options
Diffstat (limited to 'src/H5Ipublic.h')
| -rw-r--r-- | src/H5Ipublic.h | 75 |
1 files changed, 14 insertions, 61 deletions
diff --git a/src/H5Ipublic.h b/src/H5Ipublic.h index 2e66b36..83ee6be 100644 --- a/src/H5Ipublic.h +++ b/src/H5Ipublic.h @@ -11,48 +11,6 @@ * help@hdfgroup.org. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ -/**\defgroup H5I H5I - * - * Use the functions in this module to manage identifiers defined by the HDF5 - * library. See \ref H5IUD for user-defined identifiers and identifier - * types. - * - * HDF5 identifiers are usually created as a side-effect of creating HDF5 - * entities such as groups, datasets, attributes, or property lists. - * - * Identifiers defined by the HDF5 library can be used to retrieve information - * such as path names and reference counts, and their validity can be checked. - * - * Identifiers can be updated by manipulating their reference counts. - * - * Unused identifiers should be reclaimed by closing the associated item, e.g., - * HDF5 object, or decrementing the reference count to 0. - * - * \note Identifiers (of type \ref hid_t) are run-time auxiliaries and - * not persisted in the file. - * - * \defgroup H5IUD User-defined ID Types - * \ingroup H5I - * - * The \ref H5I module contains functions to define new identifier types. - * For convenience, handles of type \ref hid_t can then be associated with the - * new identifier types and user objects. - * - * New identifier types can be created by registering a new identifier type - * with the HDF5 library. Once a new identifier type has bee registered, - * it can be used to generate identifiers for user objects. - * - * User-defined identifier types can be searched and iterated. - * - * Like library-defined identifiers, user-defined identifiers \Emph{and} - * identifier types are reference counted, and the reference counts can be - * manipulated accordingly. - * - * User-defined identifiers no longer in use should be deleted or reclaimed, - * and identifier types should be destroyed if they are no longer required. - * - */ - /* * This file contains function prototypes for each exported function in * the H5I module. @@ -130,7 +88,7 @@ extern "C" { /* Public API functions */ /** - * \ingroup H5I + * \ingroup H5IUD * * \brief Registers an object under a type and returns an ID for it * @@ -152,7 +110,7 @@ extern "C" { */ H5_DLL hid_t H5Iregister(H5I_type_t type, const void *object); /** - * \ingroup H5I + * \ingroup H5IUD * * \brief Returns the object referenced by an ID * @@ -175,7 +133,7 @@ H5_DLL hid_t H5Iregister(H5I_type_t type, const void *object); */ H5_DLL void *H5Iobject_verify(hid_t id, H5I_type_t type); /** - * \ingroup H5I + * \ingroup H5IUD * * \brief Removes an ID from its type * @@ -214,12 +172,7 @@ H5_DLL void *H5Iremove_verify(hid_t id, H5I_type_t type); * \return Returns the object type if successful; otherwise #H5I_BADID. * * \details H5Iget_type() retrieves the type of the object identified by - * \p id. - * - * Valid types returned by the function are: - * \id_types - * - * If no valid type can be determined or the identifier submitted is + * \p id. If no valid type can be determined or the identifier submitted is * invalid, the function returns #H5I_BADID. * * This function is of particular use in determining the type of @@ -415,7 +368,7 @@ H5_DLL int H5Idec_ref(hid_t id); */ H5_DLL int H5Iget_ref(hid_t id); /** - * \ingroup H5I + * \ingroup H5IUD * * \brief Creates and returns a new ID type * @@ -447,7 +400,7 @@ H5_DLL int H5Iget_ref(hid_t id); */ H5_DLL H5I_type_t H5Iregister_type(size_t hash_size, unsigned reserved, H5I_free_t free_func); /** - * \ingroup H5I + * \ingroup H5IUD * * \brief Deletes all identifiers of the given type * @@ -471,7 +424,7 @@ H5_DLL H5I_type_t H5Iregister_type(size_t hash_size, unsigned reserved, H5I_free */ H5_DLL herr_t H5Iclear_type(H5I_type_t type, hbool_t force); /** - * \ingroup H5I + * \ingroup H5IUD * * \brief Removes an identifier type and all identifiers within that type * @@ -494,7 +447,7 @@ H5_DLL herr_t H5Iclear_type(H5I_type_t type, hbool_t force); */ H5_DLL herr_t H5Idestroy_type(H5I_type_t type); /** - * \ingroup H5I + * \ingroup H5IUD * * \brief Increments the reference count on an ID type * @@ -513,7 +466,7 @@ H5_DLL herr_t H5Idestroy_type(H5I_type_t type); */ H5_DLL int H5Iinc_type_ref(H5I_type_t type); /** - * \ingroup H5I + * \ingroup H5IUD * * \brief Decrements the reference count on an identifier type * @@ -533,11 +486,11 @@ H5_DLL int H5Iinc_type_ref(H5I_type_t type); */ H5_DLL int H5Idec_type_ref(H5I_type_t type); /** - * \ingroup H5I + * \ingroup H5IUD * * \brief Retrieves the reference count on an ID type * - * \param[in] type The identifier of the type whose reference count is to be retieved + * \param[in] type The identifier of the type whose reference count is to be retrieved * * \return Returns the current reference count on success, negative on failure. * @@ -552,7 +505,7 @@ H5_DLL int H5Idec_type_ref(H5I_type_t type); */ H5_DLL int H5Iget_type_ref(H5I_type_t type); /** - * \ingroup H5I + * \ingroup H5IUD * * \brief Finds the memory referred to by an ID within the given ID type such * that some criterion is satisfied @@ -593,7 +546,7 @@ H5_DLL int H5Iget_type_ref(H5I_type_t type); */ H5_DLL void *H5Isearch(H5I_type_t type, H5I_search_func_t func, void *key); /** - * \ingroup H5I + * \ingroup H5IUD * * \brief Returns the number of identifiers in a given identifier type * @@ -613,7 +566,7 @@ H5_DLL void *H5Isearch(H5I_type_t type, H5I_search_func_t func, void *key); */ H5_DLL herr_t H5Inmembers(H5I_type_t type, hsize_t *num_members); /** - * \ingroup H5I + * \ingroup H5IUD * * \brief Determines whether an identifier type is registered * |