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/dox/H5Oget_info_by_idx.dox | |
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/dox/H5Oget_info_by_idx.dox')
-rw-r--r-- | doxygen/dox/H5Oget_info_by_idx.dox | 79 |
1 files changed, 21 insertions, 58 deletions
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 * - * */ |