Skip to content

Commit

Permalink
docs(core): improve core-sample.reflection wording
Browse files Browse the repository at this point in the history
  • Loading branch information
RiscadoA committed Sep 2, 2023
1 parent 9f4d916 commit 5be4522
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/pages/3_examples/1_core/2_reflection.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ in your header, like this:

@snippet reflection.cpp Person definition

The @ref core/reflection/reflect.hpp is a very lightweight header, and thus you
should avoid including any other reflection headers in your headers whenever
possible, in order to reduce compile times.
The file @ref core/reflection/reflect.hpp is a very lightweight header which
you should include when declaring types as reflectable. It only defines the
reflection macros and the reflection function. Avoid including other
unnecessary reflection headers, which might be heavier, in order to reduce
compile times.

In your source file, you must define the reflection data for your type. This is
done through the @ref CUBOS_REFLECT_IMPL macro:
Expand Down

0 comments on commit 5be4522

Please sign in to comment.