HDF5 1.14.5
API Reference
|
We treat documentation like code and use Doxygen to markup comments in the code or create stand-alone pages.
Every RM entry consists of a subset of the elements listed below. Not every RM entry warrants the full set. More is better, and we can, perhaps, distinguish minimal, typical, and great RM entries.
A minimal RM entry must include elements 1-3, 8, 11, and 7 if applicable.
A typical RM entry is a minimal RM entry that in addition has elements 9, 10, and 12.
A great RM entry is a typical RM entry plus everything else.
The current RM is a mixed bag. Take what's there with a pinch of salt and apply the Scout Rule!
* \ingroup H5XYZ
* \brief Simplifies your life
* \param[in] name1 Description of IN parameter \p name1 * \param[out] name2 Description of OUT parameter \p name2 * \param[in,out] name3 Description of INOUT parameter \p name3 * \return Returns what you always wanted
in
, out
, or in,out
\p
* \pre The argument supplied in parameter \p name2 must be even.
* \invariant The mouse pointer will always be visible.
* \post On error, the output parameters will be unmodified.
* \deprecated Deprecated in favor of another great function.
* \details This is the heart of the matter. Try to be helpful!
* \par Example * \snippet H5F_examples.c minimal
* \note Dear reader, ... * * \attention Colorless green ideas sleep furiously. * * \warning Don't do this at home!
* \since 1.MAJOR.MINOR
* \version 1.MAJOR.MINOR Function was deprecated in this release