diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index e9eadb77..6c60981c 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -7,7 +7,7 @@ PROJECT_NAME = "@PROJECT_NAME@" PROJECT_NUMBER = "@PROJECT_VERSION@" # Add sources -INPUT = "@PROJECT_SOURCE_DIR@/README.md" "@PROJECT_SOURCE_DIR@/include" "@PROJECT_SOURCE_DIR@/src" "@PROJECT_SOURCE_DIR@/docs/pages" +INPUT = "@PROJECT_SOURCE_DIR@/README.md" "@PROJECT_SOURCE_DIR@/src" "@PROJECT_SOURCE_DIR@/docs/pages" IMAGE_PATH = "@PROJECT_SOURCE_DIR@/resources/images" EXTRACT_ALL = YES RECURSIVE = YES diff --git a/src/hdf5/HDF5IO.hpp b/src/hdf5/HDF5IO.hpp index 7dcfde87..8b1edbc2 100644 --- a/src/hdf5/HDF5IO.hpp +++ b/src/hdf5/HDF5IO.hpp @@ -36,6 +36,11 @@ class HDF5IO : public BaseIO /** * @brief Constructor for the HDF5IO class that takes a file name as input. * @param fileName The name of the HDF5 file. + * @param disableSWMRMode Disable recording of data in Single Writer + * Multiple Reader (SWMR) mode. Using SWMR ensures that the + * HDF5 file remains valid and readable at all times during + * the recording process (but does not allow for new objects + * (Groups or Datasets) to be created. */ HDF5IO(const std::string& fileName, const bool disableSWMRMode = false);