aboutsummaryrefslogtreecommitdiffstats
path: root/lib/sol2/docs/source/api/property.rst
diff options
context:
space:
mode:
authorclyne <clyne@bitgloo.com>2022-11-17 07:41:09 -0500
committerGitHub <noreply@github.com>2022-11-17 07:41:09 -0500
commit6663c25633a27fcc14d0648bd1afea7ea12f497f (patch)
treedcc2ec993db3c4b75c3e7e3df35b0494a9ce1f32 /lib/sol2/docs/source/api/property.rst
parentda0913771538fd9b1ca538615fd9aa0388608466 (diff)
parent57013add5b7c524086272be7d395f9ec5109bde2 (diff)
Merge pull request #3 from tcsullivan/lib-cleanupHEADmaster
Lib cleanup
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:
-