diff options
author | Allen Byrne <byrn@hdfgroup.org> | 2020-11-03 16:42:09 (GMT) |
---|---|---|
committer | Allen Byrne <byrn@hdfgroup.org> | 2020-11-03 16:42:09 (GMT) |
commit | c812f3fea2c9bacfc0f2d2bcad6960e9aa640dcd (patch) | |
tree | 79245efc0218e670e8c5edd9eb0d57ad045f0633 /doxygen/dox/H5Literate_by_name.dox | |
parent | dc47bb7084d55993a0a6f3725dcf79d92d7f0e65 (diff) | |
download | hdf5-c812f3fea2c9bacfc0f2d2bcad6960e9aa640dcd.zip hdf5-c812f3fea2c9bacfc0f2d2bcad6960e9aa640dcd.tar.gz hdf5-c812f3fea2c9bacfc0f2d2bcad6960e9aa640dcd.tar.bz2 |
Add doxygen auotoconf and cmake support
Diffstat (limited to 'doxygen/dox/H5Literate_by_name.dox')
-rw-r--r-- | doxygen/dox/H5Literate_by_name.dox | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/doxygen/dox/H5Literate_by_name.dox b/doxygen/dox/H5Literate_by_name.dox new file mode 100644 index 0000000..174157a --- /dev/null +++ b/doxygen/dox/H5Literate_by_name.dox @@ -0,0 +1,23 @@ +/** + * \ingroup TRAV + * \def H5Literate_by_name() + * H5Literate_by_name() is a macro that is mapped to either + * H5Literate_by_name1() or H5Literate_by_name2() Such macros are provided to + * facilitate application compatibility. Their use and mappings are fully + * described in Compatibility Macros in HDF5. If the library and/or application is + * compiled for Release 1.12 emulation, H5Literate_by_name() will be mapped to + * H5Literate_by_name2() and H5Literate_by_name1() is deprecated. With earlier + * versions, H5Literate_by_name() is mapped to H5Literate_by_name1(). + * Specific compile-time compatibility flags and the resulting mappings are as + * follows: + * \li No compatibility flag: H5Literate_by_name2() (using 1.12 source) + * H5Literate_by_name1() (using 1.10 or 1.8 source) + * \li Emulate Release 1.12: H5Literate_by_name2() + * \li Emulate Release 1.8 or 1.10 interface: H5Literate_by_name1() + * + * \todo Fix the reference. + * + * \version 1.12.0 The function H5Literate_by_name() was renamed to H5Literate_by_name1() and + * deprecated in this release. The macro H5Literate_by_name() and the + * function H5Literate_by_name2() were introduced in this release. + */ |