Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Doxygen built errors #73

Merged
merged 2 commits into from
Aug 8, 2024
Merged

Fix Doxygen built errors #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f478e83
Add missing docs for disableSWMRmode
oruebel Aug 8, 2024
aab8271
Remove unused include dir from Doxyfile to avoid build error
oruebel Aug 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/Doxyfile.in
View file
Open in desktop
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
View file
Open in desktop
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
Loading