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