From f3a30b93aa76f546144c744a08a4ed04bef95192 Mon Sep 17 00:00:00 2001 From: Loek Le Blansch Date: Mon, 9 Dec 2024 15:46:30 +0100 Subject: more WIP doxygen --- src/doc/feature/proxy.dox | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'src/doc/feature/proxy.dox') 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); } ``` -- cgit v1.2.3