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] doc updates

Browse Source
This commit is contained in:
ThePhD 2017-08-22 11:01:08 -04:00
parent e4c3ded4b2
commit 50a646de48
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/compilation.rst
View File

@ -6,9 +6,9 @@ getting good final product out of sol2
supported compilers
-------------------
GCC 7.x is now out alongside Visual Studio 2017. This means that `sol2 release v2.18.0`_ is the current version of the code targeted at the older compilers not listed below. Newer code will be targeted at working with the following compilers and leveraging their features, possibly taking advantage of whatever C++17 features are made available by the compilers and standard libraries bundled by-default with them.
GCC 7.x is now out alongside Visual Studio 2017. This means that `sol2 release v2.18.1`_ is the current version of the code targeted at the older compilers not listed below. Newer code will be targeted at working with the following compilers and leveraging their features, possibly taking advantage of whatever C++17 features are made available by the compilers and standard libraries bundled by-default with them.
``v2.18.0`` supports:
``v2.18.1`` supports:
* VC++
- Visual Studio 2017
@ -107,7 +107,7 @@ The next step for Sol from a developer standpoint is to formally make the librar
Hopefully, as things progress, we move things forward.
.. _sol2 release v2.18.0: https://github.com/ThePhD/sol2/releases/tag/v2.18.0
.. _sol2 release v2.18.0: https://github.com/ThePhD/sol2/releases/tag/v2.18.1
.. _OrfeasZ in this issue: https://github.com/ThePhD/sol2/issues/329#issuecomment-276824983
.. _issue describing preliminary steps can be found here: https://github.com/ThePhD/sol2/issues/436#issuecomment-312021508
.. _this issue here: https://github.com/ThePhD/sol2/issues/426

4
docs/source/containers.rst
View File

@ -53,7 +53,7 @@ This will let the type be pushed as a regular userdata.
.. note::
Pushing a new :doc:`usertype<api/usertype>` will prevent a qualifying C++ container type from being treated like a container. To force a type that you've registered to be treated like a container, use :doc:`sol::as_container<api/as_container>`.
Pushing a new :doc:`usertype<api/usertype>` will prevent a qualifying C++ container type from being treated like a container. To force a type that you've registered/bound as a usertype using ``new_usertype`` or ``new_simple_usertype`` to be treated like a container, use :doc:`sol::as_container<api/as_container>`.
.. _container-traits:
@ -148,7 +148,7 @@ Below are the many container operations and their override points for ``containe
.. note::
If your type does not adequately support ``begin()`` and ``end()`` and you cannot override it, use the ``sol::is_container`` trait override plus a custom implementation of ``pairs`` on your usertype to get it to work as you please. Note that a type not having proper ``begin()`` and ``end()`` will not work if you try to forcefully serialize it as a table (this means avoid using :doc:`sol::as_table<api/as_table>` and :doc:`sol::nested<api/nested>`, otherwise you will have compiler errors). Just set it or get it directly, as shown in the examples, to work with the container examples.
If your type does not adequately support ``begin()`` and ``end()`` and you cannot override it, use the ``sol::is_container`` trait override plus a custom implementation of ``pairs`` on your usertype to get it to work as you please. Note that a type not having proper ``begin()`` and ``end()`` will not work if you try to forcefully serialize it as a table (this means avoid using :doc:`sol::as_table<api/as_table>` and :doc:`sol::nested<api/nested>`, otherwise you will have compiler errors). Just set it or get it directly, as shown in the examples, to work with the C++ containers.
.. _container-classifications: