diff options
| author | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2017-03-21 19:40:18 (GMT) |
|---|---|---|
| committer | Binh-Minh Ribler <bmribler@hdfgroup.org> | 2017-03-21 19:40:18 (GMT) |
| commit | d605ce46b37a1ca33d1e474fda78009e9bdabb18 (patch) | |
| tree | 0211c506a3cc95280a24cb2426a4d99a5b3aefa8 /c++/src/H5IdComponent.cpp | |
| parent | 41a54b4fab616246ba3954e217827a7808c6adea (diff) | |
| parent | 7a799387e100138f1300c29810e9032f66436fcf (diff) | |
| download | hdf5-d605ce46b37a1ca33d1e474fda78009e9bdabb18.zip hdf5-d605ce46b37a1ca33d1e474fda78009e9bdabb18.tar.gz hdf5-d605ce46b37a1ca33d1e474fda78009e9bdabb18.tar.bz2 | |
Merge pull request #357 in HDFFV/hdf5 from ~BMRIBLER/hdf5_1_10_bmr:hdf5_1_10 to hdf5_1_10
* commit '7a799387e100138f1300c29810e9032f66436fcf':
Description: Fixed typos and missing items in function headers, that were revealed by Doxygen, and revised various comments. Platforms tested: Linux/32 2.6 (jam) Linux/64 (platypus) Darwin (osx1010test)
Description: Updated the C++ API sections.
Diffstat (limited to 'c++/src/H5IdComponent.cpp')
| -rw-r--r-- | c++/src/H5IdComponent.cpp | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/c++/src/H5IdComponent.cpp b/c++/src/H5IdComponent.cpp index 0bcc67a..122479f 100644 --- a/c++/src/H5IdComponent.cpp +++ b/c++/src/H5IdComponent.cpp @@ -24,6 +24,7 @@ namespace H5 { +#ifndef DOXYGEN_SHOULD_SKIP_THIS // This flag indicates whether H5Library::initH5cpp has been called to register // the terminating functions with atexit() bool IdComponent::H5cppinit = false; @@ -32,6 +33,7 @@ bool IdComponent::H5cppinit = false; // Subclasses that have global constants use it. This is a temporary // work-around in 1.8.16. It will be removed after HDFFV-9540 is fixed. bool IdComponent::H5dontAtexit_called = false; +#endif // DOXYGEN_SHOULD_SKIP_THIS //-------------------------------------------------------------------------- // Function: IdComponent::incRefCount @@ -165,7 +167,7 @@ H5I_type_t IdComponent::getHDFObjType() const // Function: getNumMembers (static) ///\brief Returns the number of members of the given type. ///\return Number of members -///\Description +///\par Description /// If there is no member of the given type, getNumMembers will /// return 0. Valid types are: /// \li \c H5I_FILE (= 1) @@ -197,9 +199,9 @@ hsize_t IdComponent::getNumMembers(H5I_type_t type) // Function: isValid (static) ///\brief Checks if the given ID is valid. ///\return true if the given identifier is valid, and false, otherwise. -///\Description +///\par Description /// A valid ID is one that is in use and has an application -/// reference count of at least 1. +/// reference count of at least 1. // Programmer Binh-Minh Ribler - Mar 1, 2017 //-------------------------------------------------------------------------- bool IdComponent::isValid(hid_t an_id) @@ -219,7 +221,7 @@ bool IdComponent::isValid(hid_t an_id) ///\brief Queries if a given type is currently registered with the /// library. ///\return true if the given type exists, and false, otherwise. -///\Description +///\par Description /// Valid types are: /// \li \c H5I_FILE (= 1) /// \li \c H5I_GROUP |