diff options
| author | David Robillard <d@drobilla.net> | 2014-08-08 14:46:53 +0000 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2014-08-08 14:46:53 +0000 |
| commit | b40211f7fdbaf9f56dd33b22674c2d3b0b1764c6 (patch) | |
| tree | 6d0b47616fb78ea7c06fe7caa2e1166f34a08141 /raul/SRMWQueue.hpp | |
| parent | 6773fba30029b5050a099ab0dd91ec15352a9f2b (diff) | |
| download | raul-b40211f7fdbaf9f56dd33b22674c2d3b0b1764c6.tar.gz raul-b40211f7fdbaf9f56dd33b22674c2d3b0b1764c6.tar.bz2 raul-b40211f7fdbaf9f56dd33b22674c2d3b0b1764c6.zip | |
Use Markdown in doc comments for better source readability.
git-svn-id: http://svn.drobilla.net/lad/trunk/raul@5429 a436a847-0d15-0410-975c-d299462d15a1
Diffstat (limited to 'raul/SRMWQueue.hpp')
| -rw-r--r-- | raul/SRMWQueue.hpp | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/raul/SRMWQueue.hpp b/raul/SRMWQueue.hpp index 9562a87..2a36e5b 100644 --- a/raul/SRMWQueue.hpp +++ b/raul/SRMWQueue.hpp @@ -75,7 +75,7 @@ private: unsigned _front; ///< Circular index of element at front of queue (READER ONLY) std::atomic<int> _back; ///< Circular index 1 past element at back of queue (WRITERS ONLY) std::atomic<int> _write_space; ///< Remaining free space for new elements (all threads) - const unsigned _size; ///< Size of @ref _objects (you can store _size-1 objects) + const unsigned _size; ///< Size of `_objects` (you can store _size-1 objects) T* const _objects; ///< Fixed array containing queued elements std::atomic<bool>* const _valid; ///< Parallel array to _objects, whether loc is written or not @@ -121,7 +121,7 @@ SRMWQueue<T>::full() const * * Write thread(s) only. * - * @returns true if @a elem was successfully pushed onto the queue, + * @returns true if `elem` was successfully pushed onto the queue, * false otherwise (queue is full). */ template <typename T> |