diff options
| author | David Robillard <d@drobilla.net> | 2021-01-07 19:31:25 +0100 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2021-01-07 19:31:25 +0100 |
| commit | 7cc90d01f3cd0c9fe620e8dec17e89a91d2d8345 (patch) | |
| tree | 68c594c96457f73e1498f296adfd5761d994c012 /include/raul/DoubleBuffer.hpp | |
| parent | d1f6bd5a5828064b2cca487deff1065e33727fcf (diff) | |
| download | raul-7cc90d01f3cd0c9fe620e8dec17e89a91d2d8345.tar.gz raul-7cc90d01f3cd0c9fe620e8dec17e89a91d2d8345.tar.bz2 raul-7cc90d01f3cd0c9fe620e8dec17e89a91d2d8345.zip | |
Clean up documentation comments
Diffstat (limited to 'include/raul/DoubleBuffer.hpp')
| -rw-r--r-- | include/raul/DoubleBuffer.hpp | 22 |
1 files changed, 12 insertions, 10 deletions
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<typename T> class DoubleBuffer { |