aboutsummaryrefslogtreecommitdiff
path: root/src/doc/feature/proxy.dox
diff options
context:
space:
mode:
authorLoek Le Blansch <loek@pipeframe.xyz>2024-12-09 15:46:30 +0100
committerLoek Le Blansch <loek@pipeframe.xyz>2024-12-09 15:46:30 +0100
commitf3a30b93aa76f546144c744a08a4ed04bef95192 (patch)
tree3c4a62e7b7affb8b6f9b48e9ca8621e020c55e8b /src/doc/feature/proxy.dox
parente8e5412965f19d3966635a2c207d55ae1b12db51 (diff)
more WIP doxygen
Diffstat (limited to 'src/doc/feature/proxy.dox')
-rw-r--r--src/doc/feature/proxy.dox7
1 files changed, 6 insertions, 1 deletions
diff --git a/src/doc/feature/proxy.dox b/src/doc/feature/proxy.dox
index 02ed4a5..66bbd2f 100644
--- a/src/doc/feature/proxy.dox
+++ b/src/doc/feature/proxy.dox
@@ -6,7 +6,9 @@ namespace crepe {
\ingroup feature
\brief Use ValueBroker as if it were a regular variable
-\todo Long description
+Proxy provides operators that allow you to use a ValueBroker instance as if it
+were a regular variable. Proxy implements a constructor that allows it to be
+used as a substitute return type for any function that returns ValueBroker.
\see ValueBroker
\see Proxy
@@ -30,6 +32,9 @@ void anywhere() {
// implicitly calls .get()
int out = calculation(foo);
+
+ // explicitly cast (also calls .get())
+ int casted = int(foo);
}
```