summaryrefslogtreecommitdiffstats
path: root/include/raul/Semaphore.hpp
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2021-01-07 19:31:25 +0100
committerDavid Robillard <d@drobilla.net>2021-01-07 19:31:25 +0100
commit7cc90d01f3cd0c9fe620e8dec17e89a91d2d8345 (patch)
tree68c594c96457f73e1498f296adfd5761d994c012 /include/raul/Semaphore.hpp
parentd1f6bd5a5828064b2cca487deff1065e33727fcf (diff)
downloadraul-7cc90d01f3cd0c9fe620e8dec17e89a91d2d8345.tar.gz
raul-7cc90d01f3cd0c9fe620e8dec17e89a91d2d8345.tar.bz2
raul-7cc90d01f3cd0c9fe620e8dec17e89a91d2d8345.zip
Clean up documentation comments
Diffstat (limited to 'include/raul/Semaphore.hpp')
-rw-r--r--include/raul/Semaphore.hpp12
1 files changed, 7 insertions, 5 deletions
diff --git a/include/raul/Semaphore.hpp b/include/raul/Semaphore.hpp
index 9e8dbb1..f4dc447 100644
--- a/include/raul/Semaphore.hpp
+++ b/include/raul/Semaphore.hpp
@@ -43,6 +43,8 @@ namespace raul {
At least on Lignux, the main advantage of this is that it is fast and the
only safe way to reliably signal from a real-time audio thread. The
counting semantics also complement ringbuffers of events nicely.
+
+ @ingroup raul
*/
class Semaphore
{
@@ -68,23 +70,23 @@ public:
inline ~Semaphore() { destroy(); }
- /** Destroy and reset to a new initial value. */
+ /// Destroy and reset to a new initial value
inline void reset(unsigned initial)
{
destroy();
init(initial);
}
- /** Post/Increment/Signal */
+ /// Post/Increment/Signal
inline void post();
- /** Wait/Decrement. Return false on error. */
+ /// Wait/Decrement, return false on error
inline bool wait();
- /** Attempt Wait/Decrement. Return true iff decremented. */
+ /// Attempt Wait/Decrement, return true iff decremented
inline bool try_wait();
- /** Wait for at most `ms` milliseconds. Return true iff decremented. */
+ /// Wait for at most `ms` milliseconds, return true iff decremented
template<class Rep, class Period>
inline bool timed_wait(const std::chrono::duration<Rep, Period>& wait);