diff options
author | vchoi-hdfgroup <55293060+vchoi-hdfgroup@users.noreply.github.com> | 2020-12-16 03:18:54 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-12-16 03:18:54 (GMT) |
commit | 865b10b7a707005f08b13e92dec90e402de1f21d (patch) | |
tree | 4e368d7b13668ed0871ea99e2e052b9ffec539bd /doxygen | |
parent | f09ec2657cb0ab9b646f8a4a1d5302444c38bf72 (diff) | |
download | hdf5-865b10b7a707005f08b13e92dec90e402de1f21d.zip hdf5-865b10b7a707005f08b13e92dec90e402de1f21d.tar.gz hdf5-865b10b7a707005f08b13e92dec90e402de1f21d.tar.bz2 |
Transfer doxygen H5O RM blocks from doxygen branch to develop. (#174)
Co-authored-by: vchoi <vchoi@jelly.ad.hdfgroup.org>
Diffstat (limited to 'doxygen')
-rw-r--r-- | doxygen/dox/H5Oget_info.dox | 109 | ||||
-rw-r--r-- | doxygen/dox/H5Oget_info_by_idx.dox | 79 | ||||
-rw-r--r-- | doxygen/dox/H5Oget_info_by_name.dox | 93 | ||||
-rw-r--r-- | doxygen/dox/H5Ovisit.dox | 81 | ||||
-rw-r--r-- | doxygen/dox/H5Ovisit_by_name.dox | 80 |
5 files changed, 120 insertions, 322 deletions
diff --git a/doxygen/dox/H5Oget_info.dox b/doxygen/dox/H5Oget_info.dox index e8b7afa..ee4cd1c 100644 --- a/doxygen/dox/H5Oget_info.dox +++ b/doxygen/dox/H5Oget_info.dox @@ -1,10 +1,10 @@ /** * \ingroup H5O - * \def H5Oget_info() + * \def H5Oget_info * * #H5Oget_info is a macro that is mapped to: - * \li H5Oget_info3() - * \li H5Oget_info1() + * \li #H5Oget_info3 + * \li #H5Oget_info1 * * \details Such macros are provided to facilitate application * compatibility. Their use and mappings are fully described in @@ -12,8 +12,8 @@ * document closely. * * In HDF5 versions 1.12 and after, #H5Oget_info is mapped to - * \ref H5Oget_info3() and \ref H5Oget_info1() is deprecated. - * In version 1.10 #H5Oget_info is identical to \ref H5Oget_info1(). + * #H5Oget_info3 and #H5Oget_info1 is deprecated. + * In version 1.10 #H5Oget_info is identical to #H5Oget_info1. * * Specific compile-time compatibility flags and the resulting * mappings are as follows: @@ -22,100 +22,51 @@ * <tr> * <th>Compatibility setting</th> * <th>H5Oget_info</th> - * </tr> - * <tr> - * <td>No compatibility flag</td> - * <td>\ref H5Oget_info3() (in release 1.12)</td> * </tr> * <tr> - <td></td> - * <td>\ref H5Oget_info1() (in 1.8 or 1.10)</td> + * <td>No compatibility flag \n </td> + * <td>#H5Oget_info3 (in release 1.12) \n + * #H5Oget_info1 (in 1.8 or 1.10)</td> * </tr> * <tr> * <td>Emulate Release 1.12</td> - * <td>\ref H5Oget_info3()</td> + * <td>#H5Oget_info3</td> * </tr> * <tr> * <td>Emulate Release 1.10/1.8 interface</td> - * <td>\ref H5Oget_info1()</td> + * <td>#H5Oget_info1</td> * </tr> * </table> * * \note If you are iterating through a lot of different objects to - * retrieve information via the H5Oget_info() family of routines, + * retrieve information via the #H5Oget_info family of routines, * you may see memory building up. This can be due to memory * allocation for metadata such as object headers and messages * when the iterated objects are put into the metadata cache. * \note * If the memory buildup is not desirable, you can configure a - * smaller cache via H5Fset_mdc_config() or set the file access - * property list via H5Pset_mdc_config(). A smaller sized cache + * smaller cache via #H5Fset_mdc_config or set the file access + * property list via #H5Pset_mdc_config. A smaller sized cache * will force metadata entries to be evicted from the cache, * thus freeing the memory associated with the entries. * - * \todo Fix reference to the document + * \version 1.12.0 The macro #H5Oget_info and the function #H5Oget_info3 + * were added, and #H5Oget_info1 was deprecated. + * \version 1.10.5 The macro #H5Oget_info was removed. The functions + * #H5Oget_info1 and #H5Oget_info are identical + * in this release. This change was added to restore the + * broken API compatibility introduced in HDF5-1.10.3. + * \version 1.10.3 The function #H5Oget_info was renamed + * #H5Oget_info1. The macro #H5Oget_info and the function + * #H5Oget_info2 were introduced in this release. + * \version 1.8.15 Added a note about the valid values for the \c version field + * in the H5O_hdr_info_t structure. + * \version 1.8.11 Fortran subroutine introduced in this release. + * \version 1.8.10 Added #H5O_type_t structure to the Description section. + * Separated H5O_hdr_info_t structure from + * #H5O_info_t in the Description section. Clarified the + * definition and implementation of the time fields. * - * \par Version - * <table> - * <tr> - * <th>Release</th> - * <th>Change</th> - * </tr> - * <tr> - * <td>1.12.0</td> - * <td>The macro #H5Oget_info and the function \ref H5Oget_info3() were added, - * and \ref H5Oget_info1() was deprecated.</td> - * </tr> - * <tr> - * <td>1.10.5</td> - * <td>The macro #H5Oget_info was removed.</td> - * </tr> - * <tr> - * <td></td> - * <td>The functions \ref H5Oget_info1() and - * #H5Oget_info are identical in this release.</td> - * </tr> - * <tr> - * <td></td> - * <td>This change was added to restore the broken API compatibility - * introduced in HDF5-1.10.3.</td> - * </tr> - * <tr> - * <td>1.10.3</td> - * <td>The function \ref H5Oget_info() was renamed \ref H5Oget_info1.</td> - * </tr> - * <tr> - * <td></td> - * <td>The macro #H5Oget_info and the function \ref H5Oget_info2() were - * introduced in this release.</td> - * </tr> - * <tr> - * <td>1.8.15</td> - * <td>Added a note about the valid values for the \c version field in - * the \ref H5O_hdr_info_t structure.</td> - * </tr> - * <tr> - * <td>1.8.11</td> - * <td>Fortran subroutine introduced in this release.</td> - * </tr> - * <tr> - * <td>1.8.10</td> - * <td>Added \ref H5O_type_t structure to the Description section.</td> - * </tr> - * <tr> - * <td></td> - * <td>Separated \ref H5O_hdr_info_t structure from \ref H5O_info_t - * in the Description section.</td> - * </tr> - * <tr> - * <td></td> - * <td>Clarified the definition and implementation of the time fields.</td> - * </tr> - * <tr> - * <td>1.8.0</td> - * <td>Function introduced in this release.</td> - * </tr> - * </table> + * \since 1.8.0 * - * */ diff --git a/doxygen/dox/H5Oget_info_by_idx.dox b/doxygen/dox/H5Oget_info_by_idx.dox index 2598374..49b8031 100644 --- a/doxygen/dox/H5Oget_info_by_idx.dox +++ b/doxygen/dox/H5Oget_info_by_idx.dox @@ -1,10 +1,10 @@ /** * \ingroup H5O - * \def H5Oget_info_by_idx() + * \def H5Oget_info_by_idx * * #H5Oget_info_by_idx is a macro that is mapped to: - * \li H5Oget_info_by_idx3() - * \li H5Oget_info_by_idx1() + * \li #H5Oget_info_by_idx3 + * \li #H5Oget_info_by_idx1 * * \details Such macros are provided to facilitate application * compatibility. Their use and mappings are fully described in @@ -12,8 +12,8 @@ * document closely. * * In HDF5 versions 1.12 and after, #H5Oget_info_by_idx is mapped to - * \ref H5Oget_info_by_idx3() and \ref H5Oget_info_by_idx1() is deprecated. - * In version 1.10 #H5Oget_info_by_idx is identical to \ref H5Oget_info_by_idx1(). + * #H5Oget_info_by_idx3 and #H5Oget_info_by_idx1 is deprecated. + * In version 1.10 #H5Oget_info_by_idx is identical to #H5Oget_info_by_idx1. * * Specific compile-time compatibility flags and the resulting * mappings are as follows: @@ -23,70 +23,33 @@ * <tr> * <th>Compatibility setting</th> * <th>H5Oget_info_by_idx</th> - * </tr> - * <tr> - * <td>No compatibility flag</td> - * <td>\ref H5Oget_info_by_idx3() for 1.12</td> * </tr> * <tr> - <td></td> - * <td>\ref H5Oget_info_by_idx1() for 1.8/1.10</td> + * <td>No compatibility flag \n </td> + * <td>#H5Oget_info_by_idx3 for 1.12 \n + * #H5Oget_info_by_idx1 for 1.8/1.10</td> * </tr> * <tr> * <td>Emulate Release 1.12</td> - * <td>\ref H5Oget_info_by_idx3()</td> + * <td>#H5Oget_info_by_idx3</td> * </tr> * <tr> * <td>Emulate Release 1.10/1.8 interface</td> - * <td>\ref H5Oget_info_by_idx1()</td> + * <td>#H5Oget_info_by_idx1</td> * </tr> * </table> * - * \todo Fix reference to the document + * \version 1.12.0 The macro #H5Oget_info_by_idx and function #H5Oget_info_by_idx3 were added, + * and #H5Oget_info_by_idx1 was deprecated. + * \version 1.10.5 The macro #H5Oget_info_by_idx was removed. The functions + * #H5Oget_info_by_idx and #H5Oget_info_by_idx1 are + * identical in this release. This change was added to restore the + * broken API compatibility introduced in HDF5-1.10.3. + * \version 1.10.3 The function #H5Oget_info_by_idx was renamed #H5Oget_info_by_idx1. + * The macro #H5Oget_info_by_idx and the function #H5Oget_info_by_idx2 + * were introduced in this release. + * \version 1.8.11 Fortran subroutine introduced in this release. * - * \par Version - * <table> - * <tr> - * <th>Release</th> - * <th>Change</th> - * </tr> - * <tr> - * <td>1.12.0</td> - * <td>The macro #H5Oget_info_by_idx and function \ref H5Oget_info_by_idx3() were added, - * and \ref H5Oget_info_by_idx1() was deprecated.</td> - * </tr> - * <tr> - * <td>1.10.5</td> - * <td>The macro #H5Oget_info_by_idx was removed.</td> - * </tr> - * <tr> - * <td></td> - * <td>The functions \ref H5Oget_info_by_idx() and - * H5Oget_info_by_idx1() are identical in this release.</td> - * </tr> - * <tr> - * <td></td> - * <td>This change was added to restore the broken API compatibility - * introduced in HDF5-1.10.3.</td> - * </tr> - * <tr> - * <td>1.10.3</td> - * <td>The function \ref H5Oget_info_by_idx() was renamed \ref H5Oget_info_by_idx1.</td> - * </tr> - * <tr> - * <td></td> - * <td>The macro #H5Oget_info_by_idx and the function \ref H5Oget_info_by_idx2() were - * introduced in this release.</td> - * </tr> - * <tr> - * <td>1.8.11</td> - * <td>Fortran subroutine introduced in this release.</td> - * </tr> - * <tr> - * <td>1.8.0</td> - * <td>Function introduced in this release.</td> - * </tr> - * </table> + * \since 1.8.0 * - * */ diff --git a/doxygen/dox/H5Oget_info_by_name.dox b/doxygen/dox/H5Oget_info_by_name.dox index b1b9540..18f7d28 100644 --- a/doxygen/dox/H5Oget_info_by_name.dox +++ b/doxygen/dox/H5Oget_info_by_name.dox @@ -1,10 +1,10 @@ /** * \ingroup H5O - * \def H5Oget_info_by_name() + * \def H5Oget_info_by_name * * #H5Oget_info_by_name is a macro that is mapped to: - * \li H5Oget_info_by_name3() - * \li H5Oget_info_by_name1() + * \li #H5Oget_info_by_name3 + * \li #H5Oget_info_by_name1 * * \details Such macros are provided to facilitate application * compatibility. Their use and mappings are fully described in @@ -12,9 +12,9 @@ * document closely. * * In HDF5 versions 1.12 and after, #H5Oget_info_by_name is mapped to - * \ref H5Oget_info_by_name3(). In version 1.10 #H5Oget_info_by_name is - * identical to \ref H5Oget_info_by_name1(). - * + * #H5Oget_info_by_name3. In version 1.10 #H5Oget_info_by_name is + * identical to #H5Oget_info_by_name1. + * * Specific compile-time compatibility flags and the resulting * mappings are as follows: * @@ -23,77 +23,36 @@ * <tr> * <th>Compatibility setting</th> * <th>H5Oget_info_by_name</th> - * </tr> - * <tr> - * <td>No compatibility flag</td> - * <td>\ref H5Oget_info_by_name3() for 1.12 and above</td> * </tr> * <tr> - <td></td> - * <td>\ref H5Oget_info_by_name1() for 1.8 or 1.10</td> + * <td>No compatibility flag \n </td> + * <td>#H5Oget_info_by_name3 for 1.12 and above \n + * #H5Oget_info_by_name1 for 1.8 or 1.10</td> * </tr> * <tr> * <td>Emulate Release 1.12</td> - * <td>\ref H5Oget_info_by_name3()</td> + * <td>#H5Oget_info_by_name3</td> * </tr> * <tr> * <td>Emulate Release 1.10 or 1.8 interface</td> - * <td>\ref H5Oget_info_by_name1()</td> - * </tr> - * </table> - * - * \todo Fix reference to the document; exchange 1.8.8 and 1.8.0 - * - * \par Version - * <table> - * <tr> - * <th>Release</th> - * <th>Change</th> - * </tr> - * <tr> - * <td>1.12.0</td> - * <td>The macro #H5Oget_info_by_name and function \ref H5Oget_info_by_name3() were added - * and \ref H5Oget_info_by_name1() was deprecated.</td> - * </tr> - * <tr> - * <td>1.10.5</td> - * <td>The macro #H5Oget_info_by_name was removed.</td> - * </tr> - * <tr> - * <td></td> - * <td>The functions \ref H5Oget_info_by_name() and - * H5Oget_info_by_name1() are identical in this release.</td> - * </tr> - * <tr> - * <td></td> - * <td>This change was added to restore the broken API compatibility - * introduced in HDF5-1.10.3.</td> - * </tr> - * <tr> - * <td>1.10.3</td> - * <td>The function \ref H5Oget_info_by_name() was renamed - * to \ref H5Oget_info_by_name1.</td> - * </tr> - * <tr> - * <td></td> - * <td>The macro #H5Oget_info_by_name was renamed to - * \ref H5Oget_info_by_name1().</td> - * </tr> - * <tr> - * <td></td> - * <td>The macro #H5Oget_info_by_name and the function \ref H5Oget_info_by_name2() - * were introduced in this release.</td> - * </tr> - * <tr> - * <td>1.8.8</td> - * <td>Fortran 2003 subroutine and \ref H5O_info_t derived - * type introduced in this release.</td> - * </tr> - * <tr> - * <td>1.8.0</td> - * <td>C function introduced in this release.</td> + * <td>#H5Oget_info_by_name1</td> * </tr> * </table> * + * \version 1.12.0 The macro #H5Oget_info_by_name and function + * #H5Oget_info_by_name3 were added and + * #H5Oget_info_by_name1 was deprecated. + * \version 1.10.5 The macro #H5Oget_info_by_name was removed. The functions + * #H5Oget_info_by_name and #H5Oget_info_by_name1 are + * identical in this release. This change was added to restore + * the broken API compatibility introduced in HDF5-1.10.3. + * \version 1.10.3 The function #H5Oget_info_by_name was renamed + * to #H5Oget_info_by_name1. The macro #H5Oget_info_by_name + * and the function #H5Oget_info_by_name2 were introduced + * in this release. + * \version 1.8.8 Fortran 2003 subroutine and \c h5o_info_t derived + * type introduced in this release.</td> + * + * \since 1.8.0 * */ diff --git a/doxygen/dox/H5Ovisit.dox b/doxygen/dox/H5Ovisit.dox index 5030a13..1e2a3ea 100644 --- a/doxygen/dox/H5Ovisit.dox +++ b/doxygen/dox/H5Ovisit.dox @@ -1,19 +1,19 @@ /** * \ingroup H5O - * \def H5Ovisit() + * \def H5Ovisit * * #H5Ovisit is a macro that is mapped to one of the following: - * \li H5Ovisit3() - * \li H5Ovisit1() + * \li #H5Ovisit3 + * \li #H5Ovisit1 * * \details Such macros are provided to facilitate application * compatibility. Their use and mappings are fully described in * API Compatibility Macros in HDF5; we urge you to read that * document closely. * - * In HDF5 versions 1.12 and after, \ref H5Ovisit() is mapped to - * \ref H5Ovisit3(). In version 1.10, \ref H5Ovisit() is identical - * to \ref H5Ovisit1(). + * In HDF5 versions 1.12 and after, #H5Ovisit is mapped to + * #H5Ovisit3. In version 1.10, #H5Ovisit is identical + * to #H5Ovisit1. * * Specific compile-time compatibility flags and the resulting * mappings are as follows: @@ -23,70 +23,33 @@ * <tr> * <th>Compatibility settings</th> * <th>H5Ovisit</th> - * </tr> - * <tr> - * <td>No compatibility flag</td> - * <td>\ref H5Ovisit3() in 1.12 or after</td> * </tr> * <tr> - <td></td> - * <td>\ref H5Ovisit1() for 1.8 and 1.10</td> + * <td>No compatibility flag \n </td> + * <td>#H5Ovisit3 in 1.12 or after \n + * #H5Ovisit1 for 1.8 and 1.10</td> * </tr> * <tr> * <td>Emulate Release 1.12</td> - * <td>\ref H5Ovisit3()</td> + * <td>#H5Ovisit3</td> * </tr> * <tr> * <td>Emulate Release 1.10 or 1.8 interface</td> - * <td>\ref H5Ovisit1()</td> + * <td>#H5Ovisit1</td> * </tr> * </table> * - * \todo Fix reference to the document + * \version 1.12.0 The macro #H5Ovisit and function #H5Ovisit3 were added, + * and #H5Ovisit1 was deprecated. + * \version 1.10.5 The macro #H5Ovisit was removed. The functions + * #H5Ovisit and #H5Ovisit1 are identical in this release. + * This change was added to restore the broken API compatibility + * introduced in HDF5-1.10.3. + * \version 1.10.3 The function #H5Ovisit was renamed to #H5Ovisit1. + * The macro #H5Ovisit and the function #H5Ovisit2 were + * introduced in this release. + * \version 1.8.8 Fortran subroutine and data structure added. * - * \par Version - * <table> - * <tr> - * <th>Release</th> - * <th>Change</th> - * </tr> - * <tr> - * <td>1.12.0</td> - * <td>The macro #H5Ovisit and function \ref H5Ovisit3() were added, - * and \ref H5Ovisit1() was deprecated.</td> - * </tr> - * <tr> - * <td>1.10.5</td> - * <td>The macro #H5Ovisit was removed.</td> - * </tr> - * <tr> - * <td></td> - * <td>The functions \ref H5Ovisit() and - * H5Ovisit1() are identical in this release.</td> - * </tr> - * <tr> - * <td></td> - * <td>This change was added to restore the broken API compatibility - * introduced in HDF5-1.10.3.</td> - * </tr> - * <tr> - * <td>1.10.3</td> - * <td>The function \ref H5Ovisit() was renamed to \ref H5Ovisit1.</td> - * </tr> - * <tr> - * <td></td> - * <td>The macro #H5Ovisit and the function \ref H5Ovisit2() were - * introduced in this release.</td> - * </tr> - * <tr> - * <td>1.8.8</td> - * <td>Fortran subroutine and data structure added.</td> - * </tr> - * <tr> - * <td>1.8.0</td> - * <td>C function introduced.</td> - * </tr> - * </table> + * \since 1.8.0 * - * */ diff --git a/doxygen/dox/H5Ovisit_by_name.dox b/doxygen/dox/H5Ovisit_by_name.dox index 5c6e51a..2ba4846 100644 --- a/doxygen/dox/H5Ovisit_by_name.dox +++ b/doxygen/dox/H5Ovisit_by_name.dox @@ -1,19 +1,19 @@ /** * \ingroup H5O - * \def H5Ovisit_by_name() + * \def H5Ovisit_by_name * * #H5Ovisit_by_name is a macro that is mapped to one of the following: - * \li H5Ovisit_by_name3() - * \li H5Ovisit_by_name1() + * \li #H5Ovisit_by_name3 + * \li #H5Ovisit_by_name1 * * \details Such macros are provided to facilitate application * compatibility. Their use and mappings are fully described in * API Compatibility Macros in HDF5; we urge you to read that * document closely. * - * In HDF5 versions 1.12 and after, \ref H5Ovisit_by_name() is mapped to - * \ref H5Ovisit_by_name3(). In version 1.10, \ref H5Ovisit_by_name() - * is identical to \ref H5Ovisit_by_name1(). + * In HDF5 versions 1.12 and after, #H5Ovisit_by_name is mapped to + * #H5Ovisit_by_name3. In version 1.10, #H5Ovisit_by_name + * is identical to #H5Ovisit_by_name1. * * Specific compile-time compatibility flags and the resulting * mappings are as follows: @@ -23,70 +23,32 @@ * <tr> * <th>Compatibility settings</th> * <th>H5Ovisit_by_name</th> - * </tr> - * <tr> - * <td>No compatibility flag</td> - * <td>\ref H5Ovisit_by_name3() for 1.12 and above</td> * </tr> * <tr> - <td></td> - * <td>\ref H5Ovisit_by_name1() for 1.10 or 1.8</td> + * <td>No compatibility flag \n </td> + * <td>#H5Ovisit_by_name3 for 1.12 and above \n + * #H5Ovisit_by_name1 for 1.10 or 1.8</td> * </tr> * <tr> * <td>Emulate Release 1.12 interface</td> - * <td>\ref H5Ovisit_by_name3()</td> + * <td>#H5Ovisit_by_name3</td> * </tr> * <tr> * <td>Emulate Release 1.10 or 1.8 interface</td> - * <td>\ref H5Ovisit_by_name1()</td> + * <td>#H5Ovisit_by_name1</td> * </tr> * </table> * - * \todo Fix reference to the document + * \version 1.12.0 The macro #H5Ovisit_by_name and function #H5Ovisit_by_name3 were added. + * \version 1.10.5 The macro #H5Ovisit_by_name was removed. The functions + * #H5Ovisit_by_name and #H5Ovisit_by_name1 are identical + * in this release. This change was added to restore the + * broken API compatibility introduced in HDF5-1.10.3. + * \version 1.10.3 The function #H5Ovisit_by_name was renamed to #H5Ovisit_by_name1. + * The macro #H5Ovisit_by_name and the function #H5Ovisit_by_name2 + * were introduced in this release. + * \version 1.8.8 Fortran subroutine introduced in this release. * - * \par Version - * <table> - * <tr> - * <th>Release</th> - * <th>Change</th> - * </tr> - * <tr> - * <td>1.12.0</td> - * <td>The macro #H5Ovisit_by_name and function \ref H5Ovisit_by_name3() were added. - * </tr> - * <tr> - * <td>1.10.5</td> - * <td>The macro #H5Ovisit_by_name was removed.</td> - * </tr> - * <tr> - * <td></td> - * <td>The functions \ref H5Ovisit_by_name() and - * H5Ovisit_by_name1() are identical in this release.</td> - * </tr> - * <tr> - * <td></td> - * <td>This change was added to restore the broken API compatibility - * introduced in HDF5-1.10.3.</td> - * </tr> - * <tr> - * <td>1.10.3</td> - * <td>The function \ref H5Ovisit_by_name() was renamed - * to \ref H5Ovisit_by_name1.</td> - * </tr> - * <tr> - * <td></td> - * <td>The macro #H5Ovisit_by_name and the function \ref H5Ovisit_by_name2() - * were introduced in this release.</td> - * </tr> - * <tr> - * <td>1.8.8</td> - * <td>Fortran subroutine introduced in this release.</td> - * </tr> - * <tr> - * <td>1.8.0</td> - * <td>Function introduced in this release.</td> - * </tr> - * </table> + * \since 1.8.0 * - * */ |