Skip to content

Commit

Permalink
Moved all functions out of the classes for simplicity. (#8)
Browse files Browse the repository at this point in the history
To namespace symbols, we just use namespaces instead (duh). This avoids the
need to construct an instance of a class to call its method.
  • Loading branch information
LTLA authored Oct 2, 2023
1 parent 5751971 commit 7fac2cf
Show file tree
Hide file tree
Showing 7 changed files with 380 additions and 376 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,15 +248,15 @@ We can check that a JSON/HDF5 file complies with the **uzuki** specification:

```cpp
#include "uzuki2/uzuki2.hpp"
uzuki2::validate_hdf5(h5_file_path, h5_group_name);
uzuki2::validate_json(json_file_path);
uzuki2::hdf5::validate(h5_file_path, h5_group_name);
uzuki2::json::validate(json_file_path);
```
This will raise an error if any violations of the specification are observed.
If a non-zero expected number of external objects is present:
```cpp
uzuki2::validate_hdf5(h5_file_path, h5_group_name, num_externals);
uzuki2::hdf5::validate(h5_file_path, h5_group_name, num_externals);
```

Advanced users can also use the **uzuki2** parser to load the list into memory.
Expand All @@ -266,10 +266,10 @@ which can be used to load the HDF5 contents into `std::vector`s for easier downs

```cpp
DefaultExternals ext(nexpected);
auto ptr = uzuki2::parse_hdf5<DefaultProvisioner>(file_path, group_name, ext);
auto ptr = uzuki2::hdf5::parse<DefaultProvisioner>(file_path, group_name, ext);
```
Also see the [reference documentation](https://ltla.github.io/uzuki2) for more details.
Also see the [reference documentation](https://artifactdb.github.io/uzuki2) for more details.
### Building projects
Expand All @@ -291,7 +291,7 @@ FetchContent_MakeAvailable(uzuki2)

Then you can link to **uzuki2** to make the headers available during compilation:

```
```cmake
# For executables:
target_link_libraries(myexe uzuki2)
Expand Down
4 changes: 2 additions & 2 deletions docs/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -790,8 +790,8 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.

INPUT = ../include/uzuki2/parse_hdf5.hpp \
../include/uzuki2/parse_json.hpp \
INPUT = ../include/uzuki2/parse_json.hpp \
../include/uzuki2/parse_hdf5.hpp \
../include/uzuki2/interfaces.hpp \
../include/uzuki2/uzuki2.hpp \
../README.md
Expand Down
306 changes: 151 additions & 155 deletions include/uzuki2/parse_hdf5.hpp

Large diffs are not rendered by default.

Loading

0 comments on commit 7fac2cf

Please sign in to comment.