From 7cc90d01f3cd0c9fe620e8dec17e89a91d2d8345 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Thu, 7 Jan 2021 19:31:25 +0100 Subject: Clean up documentation comments --- include/raul/DoubleBuffer.hpp | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) (limited to 'include/raul/DoubleBuffer.hpp') diff --git a/include/raul/DoubleBuffer.hpp b/include/raul/DoubleBuffer.hpp index 1693f25..ac5256d 100644 --- a/include/raul/DoubleBuffer.hpp +++ b/include/raul/DoubleBuffer.hpp @@ -21,16 +21,18 @@ namespace raul { -/** Double buffer. - * - * Can be thought of as a wrapper class to make a non-atomic type atomically - * settable (with no locking). - * - * Read/Write realtime safe, many writers safe - but set calls may fail. - * - * Space: 2*sizeof(T) + sizeof(int) + sizeof(void*) - * \ingroup raul - */ +/** + Double buffer. + + Can be thought of as a wrapper class to make a non-atomic type atomically + settable (with no locking). + + Read/Write realtime safe, many writers safe - but set calls may fail. + + Space: 2*sizeof(T) + sizeof(int) + sizeof(void*) + + @ingroup raul +*/ template class DoubleBuffer { -- cgit v1.2.1