summaryrefslogtreecommitdiffstatshomepage
path: root/3rdparty/sol2/docs/source/api/optional.rst
diff options
context:
space:
mode:
Diffstat (limited to '3rdparty/sol2/docs/source/api/optional.rst')
-rw-r--r--3rdparty/sol2/docs/source/api/optional.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/3rdparty/sol2/docs/source/api/optional.rst b/3rdparty/sol2/docs/source/api/optional.rst
new file mode 100644
index 00000000000..f999849bcd9
--- /dev/null
+++ b/3rdparty/sol2/docs/source/api/optional.rst
@@ -0,0 +1,6 @@
+optional<T>
+===========
+
+This is an implemention of `optional from the standard library`_. If it detects that a proper optional exists, it will attempt to use it. This is mostly an implementation detail, used in the :ref:`sol::stack::check_get<stack-check-get>` and :ref:`sol::stack::get\<optional\<T>><stack-get>` and ``optional<T> maybe_value = table["arf"];`` implementations for additional safety reasons.
+
+.. _optional from the standard library: http://en.cppreference.com/w/cpp/utility/optional \ No newline at end of file