diff options
| author | Andy Belle-Isle <drumsetmonkey@gmail.com> | 2019-08-30 00:45:36 -0400 |
|---|---|---|
| committer | Andy Belle-Isle <drumsetmonkey@gmail.com> | 2019-08-30 00:45:36 -0400 |
| commit | dc2493e7525bb7633f697ef10f72b72b46222249 (patch) | |
| tree | 9816755219e65d3f47fdce81c78f3736a7ddb8ab /lib/sol2/docs/source/traits.rst | |
| parent | 9d2b31797d0cfd130802b69261df2cd402e39b49 (diff) | |
Forget what I said, I just need to change git attributes to mark for vendor
Diffstat (limited to 'lib/sol2/docs/source/traits.rst')
| -rw-r--r-- | lib/sol2/docs/source/traits.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/lib/sol2/docs/source/traits.rst b/lib/sol2/docs/source/traits.rst new file mode 100644 index 0000000..ca1b566 --- /dev/null +++ b/lib/sol2/docs/source/traits.rst @@ -0,0 +1,18 @@ +customization traits +==================== + +These are customization points within the library to help you make sol3 work for the types in your framework and types. + +To learn more about various customizable traits, visit: + +* :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 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 |