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/SRSWQueue.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/SRSWQueue.hpp')
-rw-r--r-- | raul/SRSWQueue.hpp | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/raul/SRSWQueue.hpp b/raul/SRSWQueue.hpp index b9554a6..36c0f5d 100644 --- a/raul/SRSWQueue.hpp +++ b/raul/SRSWQueue.hpp @@ -62,7 +62,7 @@ public: private: std::atomic<size_t> _front; ///< Index to front of queue (circular) std::atomic<size_t> _back; ///< Index to back of queue (one past last element) (circular) - const size_t _size; ///< Size of @ref _objects (you can store _size-1 objects) + const size_t _size; ///< Size of `_objects` (you can store _size-1 objects) T* const _objects; ///< Fixed array containing queued elements }; @@ -111,7 +111,7 @@ SRSWQueue<T>::front() const /** Push an item onto the back of the SRSWQueue - realtime-safe, not thread-safe. * - * @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> |