Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
endurodave committed Dec 31, 2024
1 parent a2a7e11 commit 9bac20d
Show file tree
Hide file tree
Showing 64 changed files with 1,531 additions and 714 deletions.
6 changes: 3 additions & 3 deletions docs/html/_delegate_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -632,7 +632,7 @@
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_free_3_01_ret_type_07_args_8_8_8_08_4_html_a2395529b1984a74a7e0f3c3debe07b93"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_free_3_01_ret_type_07_args_8_8_8_08_4.html#a2395529b1984a74a7e0f3c3debe07b93">DelegateLib::DelegateFree&lt; RetType(Args...)&gt;::operator&lt;</a></div><div class="ttdeci">bool operator&lt;(const ClassType &amp;rhs) const</div><div class="ttdef"><b>Definition</b> Delegate.h:135</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_free_3_01_ret_type_07_args_8_8_8_08_4_html_a2f53b8aadaaee907b2cc46ac8f7d686b"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_free_3_01_ret_type_07_args_8_8_8_08_4.html#a2f53b8aadaaee907b2cc46ac8f7d686b">DelegateLib::DelegateFree&lt; RetType(Args...)&gt;::operator!=</a></div><div class="ttdeci">virtual bool operator!=(std::nullptr_t) const noexcept override</div><div class="ttdef"><b>Definition</b> Delegate.h:213</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_free_3_01_ret_type_07_args_8_8_8_08_4_html_a32daf44235f34ed06a33fb5cdf768842"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_free_3_01_ret_type_07_args_8_8_8_08_4.html#a32daf44235f34ed06a33fb5cdf768842">DelegateLib::DelegateFree&lt; RetType(Args...)&gt;::Clear</a></div><div class="ttdeci">void Clear() noexcept</div><div class="ttdoc">Clear the target function.</div><div class="ttdef"><b>Definition</b> Delegate.h:235</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_free_3_01_ret_type_07_args_8_8_8_08_4_html_a3e31fdd4391c352138672960a50e973d"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_free_3_01_ret_type_07_args_8_8_8_08_4.html#a3e31fdd4391c352138672960a50e973d">DelegateLib::DelegateFree&lt; RetType(Args...)&gt;::operator()</a></div><div class="ttdeci">virtual RetType operator()(Args... args) override</div><div class="ttdoc">Invoke the bound delegate function synchronously.</div><div class="ttdef"><b>Definition</b> Delegate.h:160</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_free_3_01_ret_type_07_args_8_8_8_08_4_html_a3e31fdd4391c352138672960a50e973d"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_free_3_01_ret_type_07_args_8_8_8_08_4.html#a3e31fdd4391c352138672960a50e973d">DelegateLib::DelegateFree&lt; RetType(Args...)&gt;::operator()</a></div><div class="ttdeci">virtual RetType operator()(Args... args) override</div><div class="ttdoc">Invoke the bound delegate function synchronously. Always safe to call.</div><div class="ttdef"><b>Definition</b> Delegate.h:160</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_free_3_01_ret_type_07_args_8_8_8_08_4_html_a4c3606cc50df42a8086afe833332c797"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_free_3_01_ret_type_07_args_8_8_8_08_4.html#a4c3606cc50df42a8086afe833332c797">DelegateLib::DelegateFree&lt; RetType(Args...)&gt;::operator==</a></div><div class="ttdeci">friend bool operator==(std::nullptr_t, const ClassType &amp;rhs) noexcept</div><div class="ttdef"><b>Definition</b> Delegate.h:219</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_free_3_01_ret_type_07_args_8_8_8_08_4_html_a63a0e72a1530dc63c9833c13cc0f8c91"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_free_3_01_ret_type_07_args_8_8_8_08_4.html#a63a0e72a1530dc63c9833c13cc0f8c91">DelegateLib::DelegateFree&lt; RetType(Args...)&gt;::Equal</a></div><div class="ttdeci">virtual bool Equal(const DelegateBase &amp;rhs) const override</div><div class="ttdoc">Compares two delegate objects for equality.</div><div class="ttdef"><b>Definition</b> Delegate.h:195</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_free_3_01_ret_type_07_args_8_8_8_08_4_html_a6b30ee56c2b7b8a1a3693ebc1dc2402d"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_free_3_01_ret_type_07_args_8_8_8_08_4.html#a6b30ee56c2b7b8a1a3693ebc1dc2402d">DelegateLib::DelegateFree&lt; RetType(Args...)&gt;::~DelegateFree</a></div><div class="ttdeci">~DelegateFree()</div><div class="ttdoc">Destructor ensures empty when destroyed.</div><div class="ttdef"><b>Definition</b> Delegate.h:122</div></div>
Expand All @@ -657,7 +657,7 @@
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_function_3_01_ret_type_07_args_8_8_8_08_4_html_a59314657e3dfd95c0cfcff23e0356e56"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_function_3_01_ret_type_07_args_8_8_8_08_4.html#a59314657e3dfd95c0cfcff23e0356e56">DelegateLib::DelegateFunction&lt; RetType(Args...)&gt;::operator=</a></div><div class="ttdeci">ClassType &amp; operator=(ClassType &amp;&amp;rhs) noexcept</div><div class="ttdoc">Move assignment operator that transfers ownership of resources.</div><div class="ttdef"><b>Definition</b> Delegate.h:581</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_function_3_01_ret_type_07_args_8_8_8_08_4_html_a63c632ed0a4fd7a40c27a8f05dbefa50"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_function_3_01_ret_type_07_args_8_8_8_08_4.html#a63c632ed0a4fd7a40c27a8f05dbefa50">DelegateLib::DelegateFunction&lt; RetType(Args...)&gt;::Clear</a></div><div class="ttdeci">void Clear() noexcept</div><div class="ttdoc">Clear the target function.</div><div class="ttdef"><b>Definition</b> Delegate.h:647</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_function_3_01_ret_type_07_args_8_8_8_08_4_html_a7080af7cb53567524dcfa05eb092c427"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_function_3_01_ret_type_07_args_8_8_8_08_4.html#a7080af7cb53567524dcfa05eb092c427">DelegateLib::DelegateFunction&lt; RetType(Args...)&gt;::DelegateFunction</a></div><div class="ttdeci">DelegateFunction()=default</div><div class="ttdoc">Default constructor creates an empty delegate.</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_function_3_01_ret_type_07_args_8_8_8_08_4_html_a782bbda436c2de4749fc8c098dd75945"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_function_3_01_ret_type_07_args_8_8_8_08_4.html#a782bbda436c2de4749fc8c098dd75945">DelegateLib::DelegateFunction&lt; RetType(Args...)&gt;::operator()</a></div><div class="ttdeci">virtual RetType operator()(Args... args) override</div><div class="ttdoc">Invoke the bound delegate function synchronously.</div><div class="ttdef"><b>Definition</b> Delegate.h:562</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_function_3_01_ret_type_07_args_8_8_8_08_4_html_a782bbda436c2de4749fc8c098dd75945"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_function_3_01_ret_type_07_args_8_8_8_08_4.html#a782bbda436c2de4749fc8c098dd75945">DelegateLib::DelegateFunction&lt; RetType(Args...)&gt;::operator()</a></div><div class="ttdeci">virtual RetType operator()(Args... args) override</div><div class="ttdoc">Invoke the bound delegate function synchronously. Always safe to call.</div><div class="ttdef"><b>Definition</b> Delegate.h:562</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_function_3_01_ret_type_07_args_8_8_8_08_4_html_a813f00fad959f24480192a5a44b12cdc"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_function_3_01_ret_type_07_args_8_8_8_08_4.html#a813f00fad959f24480192a5a44b12cdc">DelegateLib::DelegateFunction&lt; RetType(Args...)&gt;::Assign</a></div><div class="ttdeci">void Assign(const ClassType &amp;rhs)</div><div class="ttdoc">Assigns the state of one object to another.</div><div class="ttdef"><b>Definition</b> Delegate.h:554</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_function_3_01_ret_type_07_args_8_8_8_08_4_html_a9060a79c701f93a271858cb8b787f534"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_function_3_01_ret_type_07_args_8_8_8_08_4.html#a9060a79c701f93a271858cb8b787f534">DelegateLib::DelegateFunction&lt; RetType(Args...)&gt;::operator!=</a></div><div class="ttdeci">friend bool operator!=(std::nullptr_t, const ClassType &amp;rhs) noexcept</div><div class="ttdef"><b>Definition</b> Delegate.h:637</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_function_3_01_ret_type_07_args_8_8_8_08_4_html_a957f06ccfe0a582b17c0e30edb3caff5"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_function_3_01_ret_type_07_args_8_8_8_08_4.html#a957f06ccfe0a582b17c0e30edb3caff5">DelegateLib::DelegateFunction&lt; RetType(Args...)&gt;::Empty</a></div><div class="ttdeci">bool Empty() const noexcept</div><div class="ttdoc">Check if the delegate is bound to a target function.</div><div class="ttdef"><b>Definition</b> Delegate.h:643</div></div>
Expand Down Expand Up @@ -694,7 +694,7 @@
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_member_3_01_t_class_00_01_ret_type_07_args_8_8_8_08_4_html_aa837983f1f9c0a2f8b35fb0ea4704e5b"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_member_3_01_t_class_00_01_ret_type_07_args_8_8_8_08_4.html#aa837983f1f9c0a2f8b35fb0ea4704e5b">DelegateLib::DelegateMember&lt; TClass, RetType(Args...)&gt;::Assign</a></div><div class="ttdeci">void Assign(const ClassType &amp;rhs)</div><div class="ttdoc">Assigns the state of one object to another.</div><div class="ttdef"><b>Definition</b> Delegate.h:361</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_member_3_01_t_class_00_01_ret_type_07_args_8_8_8_08_4_html_ab772a635e195f3553f9c43f344b262df"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_member_3_01_t_class_00_01_ret_type_07_args_8_8_8_08_4.html#ab772a635e195f3553f9c43f344b262df">DelegateLib::DelegateMember&lt; TClass, RetType(Args...)&gt;::DelegateMember</a></div><div class="ttdeci">DelegateMember(ObjectPtr object, ConstMemberFunc func)</div><div class="ttdoc">Constructor to create a class instance.</div><div class="ttdef"><b>Definition</b> Delegate.h:281</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_member_3_01_t_class_00_01_ret_type_07_args_8_8_8_08_4_html_ac0ebe807ef2e92dab70422a6f97a461f"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_member_3_01_t_class_00_01_ret_type_07_args_8_8_8_08_4.html#ac0ebe807ef2e92dab70422a6f97a461f">DelegateLib::DelegateMember&lt; TClass, RetType(Args...)&gt;::DelegateMember</a></div><div class="ttdeci">DelegateMember(ObjectPtr object, MemberFunc func)</div><div class="ttdoc">Constructor to create a class instance.</div><div class="ttdef"><b>Definition</b> Delegate.h:276</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_member_3_01_t_class_00_01_ret_type_07_args_8_8_8_08_4_html_ac37f599bb6493c11c88a015c877b1530"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_member_3_01_t_class_00_01_ret_type_07_args_8_8_8_08_4.html#ac37f599bb6493c11c88a015c877b1530">DelegateLib::DelegateMember&lt; TClass, RetType(Args...)&gt;::operator()</a></div><div class="ttdeci">virtual RetType operator()(Args... args) override</div><div class="ttdoc">Invoke the bound delegate function synchronously.</div><div class="ttdef"><b>Definition</b> Delegate.h:370</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_member_3_01_t_class_00_01_ret_type_07_args_8_8_8_08_4_html_ac37f599bb6493c11c88a015c877b1530"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_member_3_01_t_class_00_01_ret_type_07_args_8_8_8_08_4.html#ac37f599bb6493c11c88a015c877b1530">DelegateLib::DelegateMember&lt; TClass, RetType(Args...)&gt;::operator()</a></div><div class="ttdeci">virtual RetType operator()(Args... args) override</div><div class="ttdoc">Invoke the bound delegate function synchronously. Always safe to call.</div><div class="ttdef"><b>Definition</b> Delegate.h:370</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_member_3_01_t_class_00_01_ret_type_07_args_8_8_8_08_4_html_ac63255c2bcc2191b5eb53486ab72e4b2"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_member_3_01_t_class_00_01_ret_type_07_args_8_8_8_08_4.html#ac63255c2bcc2191b5eb53486ab72e4b2">DelegateLib::DelegateMember&lt; TClass, RetType(Args...)&gt;::Equal</a></div><div class="ttdeci">virtual bool Equal(const DelegateBase &amp;rhs) const override</div><div class="ttdoc">Compares two delegate objects for equality.</div><div class="ttdef"><b>Definition</b> Delegate.h:410</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_member_3_01_t_class_00_01_ret_type_07_args_8_8_8_08_4_html_ad06b7ee91cc4f40440a2841a2fe2ec83"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_member_3_01_t_class_00_01_ret_type_07_args_8_8_8_08_4.html#ad06b7ee91cc4f40440a2841a2fe2ec83">DelegateLib::DelegateMember&lt; TClass, RetType(Args...)&gt;::operator=</a></div><div class="ttdeci">ClassType &amp; operator=(const ClassType &amp;rhs)</div><div class="ttdoc">Assignment operator that assigns the state of one object to another.</div><div class="ttdef"><b>Definition</b> Delegate.h:383</div></div>
<div class="ttc" id="aclass_delegate_lib_1_1_delegate_member_3_01_t_class_00_01_ret_type_07_args_8_8_8_08_4_html_ae31b9598c8f3e72d2adcbd9c0a1269e1"><div class="ttname"><a href="class_delegate_lib_1_1_delegate_member_3_01_t_class_00_01_ret_type_07_args_8_8_8_08_4.html#ae31b9598c8f3e72d2adcbd9c0a1269e1">DelegateLib::DelegateMember&lt; TClass, RetType(Args...)&gt;::operator=</a></div><div class="ttdeci">ClassType &amp; operator=(ClassType &amp;&amp;rhs) noexcept</div><div class="ttdoc">Move assignment operator that transfers ownership of resources.</div><div class="ttdef"><b>Definition</b> Delegate.h:393</div></div>
Expand Down
Loading

0 comments on commit 9bac20d

Please sign in to comment.