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] link to a previous example so people can see it

Browse Source
This commit is contained in:
ThePhD 2017-08-25 21:04:15 -04:00
parent 6ce82de04d
commit 626da4db5a
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/source/traits.rst
View File

@ -5,11 +5,14 @@ These are customization points within the library to help you make sol2 work for
To learn more about various customizable traits, visit:
* :ref:`containers detection trait<container-detection>`
- This is how to work with containers when you have an compiler error when serializing a type that has ``begin`` and ``end`` functions but isn't exactly a container.
* :doc:`containers customization traits<containers>`
- This is how to work with containers in their entirety and what operations you're afforded on them
- when you have an compiler error when serializing a type that has ``begin`` and ``end`` functions but isn't exactly a container
* :doc:`unique usertype (custom pointer) traits<api/unique_usertype_traits>`
- This is how to deal with unique usertypes, e.g. ``boost::shared_ptr``, reference-counted pointers, etc.
- Useful for custom pointers from all sorts of frameworks or handle types that employ very specific kinds of destruction semantics and access.
* :doc:`customization point tutorial<tutorial/customization>`
- This is how to customize a type to work with sol2.
- Can be used for specializations to push strings and other class types that are not natively ``std::string`` or ``const char*``.
- This is how to deal with unique usertypes, e.g. ``boost::shared_ptr``, reference-counted pointers, etc
- Useful for custom pointers from all sorts of frameworks or handle types that employ very specific kinds of destruction semantics and access
* :doc:`customization points<tutorial/customization>`
- This is how to customize a type to work with sol2
- Can be used for specializations to push strings and other class types that are not natively ``std::string`` or ``const char*``, like `a wxString, for example`_
.. _a wxString, for example: https://github.com/ThePhD/sol2/issues/140#issuecomment-237934947