Skip to content

Commit

Permalink
Deploy preview for PR 1378 🛫
Browse files Browse the repository at this point in the history
  • Loading branch information
mkuritsu committed Nov 21, 2024
1 parent aa44d1f commit d7983db
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion preview/pr-1378/group__core-reflection.html
Original file line number Diff line number Diff line change
Expand Up @@ -512,7 +512,7 @@ <h3>
<span class="n">CUBOS_REFLECT_EXTERNAL_IMPL</span><span class="p">(</span><span class="n">NotMyType</span><span class="p">)</span>
<span class="p">{</span>
<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="cm">/* create your type here */</span><span class="p">;</span>
<span class="p">}</span></pre><aside class="m-note m-default"><h4>See also</h4><p>Meant to be used with either <a href="text_8hpp.html#afc5aa5dbc675b306b24597e06dc4ce0f" class="m-doc">CUBOS_<wbr />REFLECT_<wbr />EXTERNAL_<wbr />DECL</a> or <a href="group__core-reflection.html#gab24b41a195fdf07a246383d74fd583d7" class="m-doc">CUBOS_<wbr />REFLECT_<wbr />EXTERNAL_<wbr />DECL_<wbr />TEMPLATE</a>.</p></aside>
<span class="p">}</span></pre><aside class="m-note m-default"><h4>See also</h4><p>Meant to be used with either <a href="orthographic_8hpp.html#a2ecfd07209e4aeb4bacb166b1c9a9c2e" class="m-doc">CUBOS_<wbr />REFLECT_<wbr />EXTERNAL_<wbr />DECL</a> or <a href="group__core-reflection.html#gab24b41a195fdf07a246383d74fd583d7" class="m-doc">CUBOS_<wbr />REFLECT_<wbr />EXTERNAL_<wbr />DECL_<wbr />TEMPLATE</a>.</p></aside>
</div></section>
<section class="m-doc-details" id="ga72591a0e4a14f0daab6ffa71f666b757"><div>
<h3>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ <h1>
</tr>
</tbody>
</table>
<p>By default, this function calls the static member function <code>reflect</code> of the type, which should return a pointer to an instance of <a href="classcubos_1_1core_1_1reflection_1_1Type.html" class="m-doc">Type</a>.</p><p>To implement reflection for your type, you should either:</p><ul><li>Define a static member function <code>reflect</code> with return type <code>const <a href="classcubos_1_1core_1_1reflection_1_1Type.html" class="m-doc">Type</a>&amp;</code> on your type.</li><li>Specialize this struct for your type.</li></ul><p>The first option is preferred, as it is less verbose. However, when handling external types, to which member functions cannot be added, the second option is necessary.</p><p>Both options can and should be shortened by using the macros:</p><ul><li><a href="group__core-reflection.html#gac3d484b311cc3e471620653b289977ac" class="m-doc">CUBOS_<wbr />REFLECT</a> - declaring the reflection member functions.</li><li><a href="voxel__palette__editor_2plugin_8cpp.html#ad08593825e6e6021a439f59b2b9e0ea6" class="m-doc">CUBOS_<wbr />REFLECT_<wbr />IMPL</a> - defining the reflection member functions.</li><li><a href="text_8hpp.html#afc5aa5dbc675b306b24597e06dc4ce0f" class="m-doc">CUBOS_<wbr />REFLECT_<wbr />EXTERNAL_<wbr />DECL</a> - declaring the reflection specialization.</li><li><a href="group__core-reflection.html#ga1825cb321439299e6f528a5b34ebf0e6" class="m-doc">CUBOS_<wbr />REFLECT_<wbr />EXTERNAL_<wbr />IMPL</a> - defining the reflection specialization&#x27;s functions.</li></ul>
<p>By default, this function calls the static member function <code>reflect</code> of the type, which should return a pointer to an instance of <a href="classcubos_1_1core_1_1reflection_1_1Type.html" class="m-doc">Type</a>.</p><p>To implement reflection for your type, you should either:</p><ul><li>Define a static member function <code>reflect</code> with return type <code>const <a href="classcubos_1_1core_1_1reflection_1_1Type.html" class="m-doc">Type</a>&amp;</code> on your type.</li><li>Specialize this struct for your type.</li></ul><p>The first option is preferred, as it is less verbose. However, when handling external types, to which member functions cannot be added, the second option is necessary.</p><p>Both options can and should be shortened by using the macros:</p><ul><li><a href="group__core-reflection.html#gac3d484b311cc3e471620653b289977ac" class="m-doc">CUBOS_<wbr />REFLECT</a> - declaring the reflection member functions.</li><li><a href="voxel__palette__editor_2plugin_8cpp.html#ad08593825e6e6021a439f59b2b9e0ea6" class="m-doc">CUBOS_<wbr />REFLECT_<wbr />IMPL</a> - defining the reflection member functions.</li><li><a href="orthographic_8hpp.html#a2ecfd07209e4aeb4bacb166b1c9a9c2e" class="m-doc">CUBOS_<wbr />REFLECT_<wbr />EXTERNAL_<wbr />DECL</a> - declaring the reflection specialization.</li><li><a href="group__core-reflection.html#ga1825cb321439299e6f528a5b34ebf0e6" class="m-doc">CUBOS_<wbr />REFLECT_<wbr />EXTERNAL_<wbr />IMPL</a> - defining the reflection specialization&#x27;s functions.</li></ul>
</div>
</div>
</div>
Expand Down

0 comments on commit d7983db

Please sign in to comment.