Skip to content

Commit c1e63d3

Browse files
Fixed documentation
1 parent 58afb32 commit c1e63d3

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

docs/supported_formats/cereal.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
For Cereal support, you must also include the header `<rfl/cereal.hpp>` and link to the [Cereal](https://uscilab.github.io/cereal/) library.
44
Furthermore, when compiling reflect-cpp, you need to pass `-DREFLECTCPP_CEREAL=ON` to cmake.
55

6-
Cereal is a C++ serialization library that provides multiple archive formats including binary, portable binary, JSON, and XML formats, even though we use the portable binary format by default.
6+
Cereal is a C++ serialization library that provides multiple archive formats including binary, portable binary, JSON, and XML formats, even though we use the portable binary format by default.
7+
78
## Reading and writing
89

910
Suppose you have a struct like this:
@@ -69,7 +70,7 @@ For large and complex systems of structs, it is often a good idea to split up
6970
your code into smaller compilation units. You can do so using custom constructors.
7071
7172
For the Cereal format, these must be a static function on your struct or class called
72-
`from_cereal_obj` that take a `rfl::cereal::Reader::InputVarType` as input and return
73+
`from_cereal_obj` that takes a `rfl::cereal::Reader::InputVarType` as input and return
7374
the class or the class wrapped in `rfl::Result`.
7475
7576
In your header file you can write something like this:

0 commit comments

Comments
 (0)