Skip to content

Commit

Permalink
Improve doc of 'HIGHFIVE_REGISTER_TYPE'.
Browse files Browse the repository at this point in the history
  • Loading branch information
1uc committed Feb 12, 2024
1 parent e639820 commit 3a4a85c
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion include/highfive/H5DataType.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -475,12 +475,15 @@ using FixedLenStringArray H5_DEPRECATED_USING("Use 'std::vector<std::string>'.")
/// This macro has to be called outside of any namespace.
///
/// \code{.cpp}
/// namespace app {
/// enum FooBar { FOO = 1, BAR = 2 };
/// EnumType create_enum_foobar() {
/// return EnumType<FooBar>({{"FOO", FooBar::FOO},
/// {"BAR", FooBar::BAR}});
/// }
/// HIGHFIVE_REGISTER_TYPE(FooBar, create_enum_foobar)
/// }
///
/// HIGHFIVE_REGISTER_TYPE(FooBar, ::app::create_enum_foobar)
/// \endcode
#define HIGHFIVE_REGISTER_TYPE(type, function) \
template <> \
Expand Down

0 comments on commit 3a4a85c

Please sign in to comment.