StarMirror/sol2
1
0
Fork 0
mirror of https://github.com/ThePhD/sol2.git synced 2024-03-22 13:10:44 +08:00
Code Issues Projects Releases Wiki Activity

[ci-skip] update resolve docs

Browse Source
This commit is contained in:
ThePhD 2016-12-26 15:06:41 -05:00
parent 77a7bf12a0
commit bacd93ad08
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/api/resolve.rst
View File

@ -19,6 +19,7 @@ utility to pick overloaded C++ function calls
int overloaded(int x, int y, int z);
struct thing {
int overloaded() const;
int overloaded(int x);
int overloaded(int x, int y);
int overloaded(int x, int y, int z);
@ -33,8 +34,9 @@ You can disambiguate them using ``resolve``:
auto two_argument_func = resolve<int(int, int)>( overloaded );
auto three_argument_func = resolve<int(int, int, int)>( overloaded );
auto member_three_argument_func = resolve<int(int, int, int)>( &thing::overloaded );
auto member_zero_argument_const_func = resolve<int() const>( &thing::overloaded );
This resolution becomes useful when setting functions on a :doc:`table<table>` or :doc:`state_view<state>`:
It is *important* to note that ``const`` is placed at the end for when you desire const overloads. You will get compiler errors if you are not specific and do not properly disambiguate for const member functions. This resolution also becomes useful when setting functions on a :doc:`table<table>` or :doc:`state_view<state>`:
.. code-block:: cpp
:linenos: