diff options
author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2022-09-13 03:37:01 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-09-13 03:37:01 (GMT) |
commit | 9348ba920eecacd35adde6c4573cc85c6033dc65 (patch) | |
tree | 9e23eb5142b4bbed1385c88d7409cd3c5586e5d3 /src | |
parent | 033b7ace5aff35cced7561921789176fb3831cdb (diff) | |
download | hdf5-9348ba920eecacd35adde6c4573cc85c6033dc65.zip hdf5-9348ba920eecacd35adde6c4573cc85c6033dc65.tar.gz hdf5-9348ba920eecacd35adde6c4573cc85c6033dc65.tar.bz2 |
1 12 doxygen merge from 1.10 (#2094)
Diffstat (limited to 'src')
-rw-r--r-- | src/H5ACpublic.h | 4 | ||||
-rw-r--r-- | src/H5Dpublic.h | 2 | ||||
-rw-r--r-- | src/H5Emodule.h | 20 | ||||
-rw-r--r-- | src/H5Imodule.h | 4 | ||||
-rw-r--r-- | src/H5Lmodule.h | 4 | ||||
-rw-r--r-- | src/H5Omodule.h | 4 | ||||
-rw-r--r-- | src/H5PLmodule.h | 4 | ||||
-rw-r--r-- | src/H5Ppublic.h | 2 | ||||
-rw-r--r-- | src/H5Rmodule.h | 4 | ||||
-rw-r--r-- | src/H5VLmodule.h | 4 | ||||
-rw-r--r-- | src/H5Zmodule.h | 4 | ||||
-rw-r--r-- | src/H5public.h | 2 |
12 files changed, 41 insertions, 17 deletions
diff --git a/src/H5ACpublic.h b/src/H5ACpublic.h index 42bc090..f9da6f6 100644 --- a/src/H5ACpublic.h +++ b/src/H5ACpublic.h @@ -563,7 +563,7 @@ typedef struct H5AC_cache_config_t { * The value must lie in the interval [0.0, 1.0]. 0.01 is a good place to * start in the serial case. In the parallel case, a larger value is needed * -- see the overview of the metadata cache in the - * “Metadata Caching in HDF5” section of the -- <em>HDF5 User’s Guide</em> + * “Metadata Caching in HDF5” section of the -- <em>\ref UG</em> * for details. */ size_t max_size; @@ -760,7 +760,7 @@ typedef struct H5AC_cache_image_config_t { * H5AC__CACHE_IMAGE__ENTRY_AGEOUT__MAX (100). * * \ref H5AC__CACHE_IMAGE__ENTRY_AGEOUT__NONE means that no limit is - * imposed on number of times a prefeteched entry can appear in subsequent + * imposed on number of times a prefetched entry can appear in subsequent * cache images. * * A value of 0 prevents prefetched entries from being included in cache diff --git a/src/H5Dpublic.h b/src/H5Dpublic.h index d39e2c6..db628a3 100644 --- a/src/H5Dpublic.h +++ b/src/H5Dpublic.h @@ -360,7 +360,7 @@ H5_DLL hid_t H5Dcreate_anon(hid_t loc_id, hid_t type_id, hid_t space_id, hid_t d * -------------------------------------------------------------------------- * \ingroup H5D * - * \brief Creates a new dataset and links it into the file + * \brief Opens an existing dataset * * \fgdta_loc_id * \param[in] name Name of the dataset to open diff --git a/src/H5Emodule.h b/src/H5Emodule.h index 5abdb6a..c827d70 100644 --- a/src/H5Emodule.h +++ b/src/H5Emodule.h @@ -84,24 +84,24 @@ * an error stack ID is needed as a parameter, \ref H5E_DEFAULT can be used to indicate the library’s default * stack. The first error record of the error stack, number #000, is produced by the API function itself and * is usually sufficient to indicate to the application what went wrong. - * <table> - * <caption align=top>Example: An Error Message</caption> - * <tr> - * <td> - * <p>If an application calls \ref H5Tclose on a + * <table> + * <caption align=top>Example: An Error Message</caption> + * <tr> + * <td> + * <p>If an application calls \ref H5Tclose on a * predefined datatype then the following message is * printed on the standard error stream. This is a * simple error that has only one component, the API * function; other errors may have many components. - * <p><code><pre> + * <p><code><pre> * HDF5-DIAG: Error detected in HDF5 (1.10.9) thread 0. * #000: H5T.c line ### in H5Tclose(): predefined datatype * major: Function argument * minor: Bad value - * </pre></code> - * </td> - * </tr> - * </table> + * </pre></code> + * </td> + * </tr> + * </table> * In the example above, we can see that an error record has a major message and a minor message. A major * message generally indicates where the error happens. The location can be a dataset or a dataspace, for * example. A minor message explains further details of the error. An example is “unable to open file”. diff --git a/src/H5Imodule.h b/src/H5Imodule.h index 1ad9f1b..71b8f7d 100644 --- a/src/H5Imodule.h +++ b/src/H5Imodule.h @@ -29,6 +29,10 @@ #define H5_MY_PKG_ERR H5E_ATOM #define H5_MY_PKG_INIT NO +/** \page H5I_UG The HDF5 Identifiers + * @todo Under Construction + */ + /** * \defgroup H5I Identifiers (H5I) * diff --git a/src/H5Lmodule.h b/src/H5Lmodule.h index f61b891..f373ba1 100644 --- a/src/H5Lmodule.h +++ b/src/H5Lmodule.h @@ -29,6 +29,10 @@ #define H5_MY_PKG_ERR H5E_LINK #define H5_MY_PKG_INIT YES +/** \page H5L_UG The HDF5 Links + * @todo Under Construction + */ + /** * \defgroup H5L Links (H5L) * diff --git a/src/H5Omodule.h b/src/H5Omodule.h index 977861b..0c482c5 100644 --- a/src/H5Omodule.h +++ b/src/H5Omodule.h @@ -29,6 +29,10 @@ #define H5_MY_PKG_ERR H5E_OHDR #define H5_MY_PKG_INIT YES +/** \page H5O_UG The HDF5 Objects + * @todo Under Construction + */ + /** * \defgroup H5O Objects (H5O) * diff --git a/src/H5PLmodule.h b/src/H5PLmodule.h index 84d3583..66a24fd 100644 --- a/src/H5PLmodule.h +++ b/src/H5PLmodule.h @@ -27,6 +27,10 @@ #define H5_MY_PKG_ERR H5E_PLUGIN #define H5_MY_PKG_INIT YES +/** \page H5PL_UG The HDF5 Plugins + * @todo Under Construction + */ + /** * \defgroup H5PL Dynamically-loaded Plugins (H5PL) * diff --git a/src/H5Ppublic.h b/src/H5Ppublic.h index 1f4503d..8990922 100644 --- a/src/H5Ppublic.h +++ b/src/H5Ppublic.h @@ -829,7 +829,7 @@ H5_DLL htri_t H5Pexist(hid_t plist_id, const char *name); */ H5_DLL herr_t H5Pget(hid_t plist_id, const char *name, void *value); /** - *\ingroup PLCR + * \ingroup PLCR * * \brief Returns the property list class identifier for a property list * diff --git a/src/H5Rmodule.h b/src/H5Rmodule.h index c561058..eb69466 100644 --- a/src/H5Rmodule.h +++ b/src/H5Rmodule.h @@ -25,6 +25,10 @@ #define H5_MY_PKG_ERR H5E_REFERENCE #define H5_MY_PKG_INIT YES +/** \page H5R_UG The HDF5 References + * @todo Under Construction + */ + /** * \defgroup H5R References (H5R) * diff --git a/src/H5VLmodule.h b/src/H5VLmodule.h index fa03e85..1ad0c8d 100644 --- a/src/H5VLmodule.h +++ b/src/H5VLmodule.h @@ -53,13 +53,13 @@ * <table> * <tr> * <td> - * \image html V_fig1.gif "The VOL Architecture" + * \image html vol_architecture.png "The VOL Architecture" * </td> * </tr> * </table> * * Not all public HDF5 API calls pass through the VOL. Only calls which require manipulating storage go - * through the VOL and require a VOL connector authorto implement the appropriate callback. Dataspace, + * through the VOL and require a VOL connector author to implement the appropriate callback. Dataspace, * property list, error stack, etc. calls have nothing to do with storage manipulation or querying and * do not use the VOL. This may be confusing when it comes to property list calls, since many of those * calls set properties for storage. Property lists are just collections of key-value pairs, though, so diff --git a/src/H5Zmodule.h b/src/H5Zmodule.h index b3a52fd..fddfd7f 100644 --- a/src/H5Zmodule.h +++ b/src/H5Zmodule.h @@ -29,6 +29,10 @@ #define H5_MY_PKG_ERR H5E_PLINE #define H5_MY_PKG_INIT YES +/** \page H5Z_UG The HDF5 Filters + * @todo Under Construction + */ + /** * \defgroup H5Z Filters (H5Z) * diff --git a/src/H5public.h b/src/H5public.h index 3103298..ca06025 100644 --- a/src/H5public.h +++ b/src/H5public.h @@ -694,7 +694,7 @@ H5_DLL herr_t H5get_libversion(unsigned *majnum, unsigned *minnum, unsigned *rel * currently linked. If this check fails, H5check_version() causes the * application to abort (by means of a standard C abort() call) and * prints information that is usually useful for debugging. This - * precaution is is taken to avoid the risks of data corruption or + * precaution is taken to avoid the risks of data corruption or * segmentation faults. * * The most common cause of this failure is that an application was |