summaryrefslogtreecommitdiffstats
path: root/doxygen/dox/H5Ovisit.dox
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2021-05-04 22:46:10 (GMT)
committerGitHub <noreply@github.com>2021-05-04 22:46:10 (GMT)
commit021d7c7278fd9c182802f2d5419438716beb37bc (patch)
tree772b610158e3c771e575a5d7095ebfa589480240 /doxygen/dox/H5Ovisit.dox
parent0801e83615713d95174ed936462310cea32328c7 (diff)
downloadhdf5-021d7c7278fd9c182802f2d5419438716beb37bc.zip
hdf5-021d7c7278fd9c182802f2d5419438716beb37bc.tar.gz
hdf5-021d7c7278fd9c182802f2d5419438716beb37bc.tar.bz2
Hdf5 1 12 doxygen merge (#615)
* OESS-98 fix tools test for plugins * sync fork * Merge of changes from dev * Move problem option to bottom of the list until fixed * HDFFV-11106 - fix parsing optional args * HDFFV-11106 add note * grammer fix * Whitespace after clang formatting * Undo format version 11 changes * Update check to working version * Merge workflow and minor changes from develop * Update supported platforms * PR#3 merge from develop * Merge gcc 10 diagnostics option from develop * Merge #318 OSX changes from develop * Merge serval small changes from dev * fix typo * Minor non-space formatting changes * GH #386 copyright corrections for java folder * revert because logic requires false return * Merges from develop #358 patches from vtk #361 fix header guard spelling * Remove case statement for H5I_EVENTSET * Correct call with versioning * Remove tabs * Double underscore change * Merges from develop #340 clang -Wformat-security warnings #360 Fixed uninitialized warnings Remove more underscores from header guards * Merge #380 from develop * Correct date entry * Split format source and commit changes on repo push * remove pre-split setting * Change windows TS to use older VS. * HDFFV-11212 JNI export util and Javadoc * Suggested review changes * Another change found * Committing clang-format changes * Some Javadoc warning fixes * Committing clang-format changes * Updated javadoc fixes * HDFFV-11228/9 merges from develop * remove obsolete debug comment * Fix conflict * HDFFV-11229 merge changes from develop * HDFFV-11229 merge second compare from develop * HDFFV-11229 fix reference file * HDFFV-11229 update autotools test script for two ref files * HDFFV-11229 merge dev changes for long double display in tools * Committing clang-format changes * Update with changes from develop * Add "option" command for clang options * Rework CMake add_custom to use the BYPRODUCTS argument Update pkgconfig scripts for parallel builds. Fix install COPYING file reference. Remove unused round defines. Change CMake default setting of BUILD_CPP to off. * Whitespace changes * Rework CMake add_custom to use the BYPRODUCTS argument * Revert CMake configure checks for round defines * With VS 2015 minimum strdup is supported * Doxygen comments merged from develop * doxygen build updates * Correct version string for map functions Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Diffstat (limited to 'doxygen/dox/H5Ovisit.dox')
-rw-r--r--doxygen/dox/H5Ovisit.dox81
1 files changed, 22 insertions, 59 deletions
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 &nbsp;</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
*
- *
*/