aboutsummaryrefslogtreecommitdiffstats
path: root/lib/sol2/docs/source/api/property.rst
diff options
context:
space:
mode:
authorClyne Sullivan <clyne@bitgloo.com>2022-11-15 07:35:07 -0500
committerClyne Sullivan <clyne@bitgloo.com>2022-11-15 07:35:07 -0500
commita056c15dd3781b4f6bb89fdd738b14cafc00cd85 (patch)
tree1775a5913c7bc87563b6b4a29c63514cf15b4185 /lib/sol2/docs/source/api/property.rst
parent1405d648b6264cfda7c46f5b251258335abaee83 (diff)
parent57013add5b7c524086272be7d395f9ec5109bde2 (diff)
merge branch lib-cleanup into ui
Diffstat (limited to 'lib/sol2/docs/source/api/property.rst')
-rw-r--r--lib/sol2/docs/source/api/property.rst18
1 files changed, 0 insertions, 18 deletions
diff --git a/lib/sol2/docs/source/api/property.rst b/lib/sol2/docs/source/api/property.rst
deleted file mode 100644
index 7141bc9..0000000
--- a/lib/sol2/docs/source/api/property.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-property
-========
-*wrapper to specify read and write variable functionality using functions*
-
-.. code-block:: cpp
-
- template <typename Read, typename Write>
- decltype(auto) property ( Read&& read_function, Write&& write_function );
- template <typename Read>
- decltype(auto) property ( Read&& read_function );
- template <typename Write>
- decltype(auto) property ( Write&& write_function );
-
-These set of functions create a type which allows a setter and getter pair (or a single getter, or a single setter) to be used to create a variable that is either read-write, read-only, or write-only. When used during :doc:`usertype<usertype>` construction, it will create a variable that uses the setter/getter member function specified.
-
-.. literalinclude:: ../../../examples/source/property.cpp
- :linenos:
-