Skip to content

Commit

Permalink
Merge pull request #73 from NeurodataWithoutBorders/add/swmr_docs
Browse files Browse the repository at this point in the history
Fix Doxygen built errors
  • Loading branch information
oruebel authored Aug 8, 2024
2 parents e36766f + aab8271 commit 42d3320
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions src/hdf5/HDF5IO.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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);

Expand Down

0 comments on commit 42d3320

Please sign in to comment.