diff options
| -rw-r--r-- | raul/SRMWQueue.hpp | 4 | ||||
| -rw-r--r-- | raul/SRSWQueue.hpp | 4 | ||||
| -rw-r--r-- | raul/Symbol.hpp | 2 | ||||
| -rw-r--r-- | raul/TimeStamp.hpp | 4 |
4 files changed, 7 insertions, 7 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> 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> diff --git a/raul/Symbol.hpp b/raul/Symbol.hpp index 6f0dd91..551d770 100644 --- a/raul/Symbol.hpp +++ b/raul/Symbol.hpp @@ -104,7 +104,7 @@ public: /** Convert a string to a valid symbol. * - * This will make a best effort at turning @a str into a complete, valid + * This will make a best effort at turning `str` into a complete, valid * Symbol, and will always return one. */ static inline Symbol symbolify(const std::basic_string<char>& in) { diff --git a/raul/TimeStamp.hpp b/raul/TimeStamp.hpp index ea8b04c..f27e761 100644 --- a/raul/TimeStamp.hpp +++ b/raul/TimeStamp.hpp @@ -37,8 +37,8 @@ public: SECONDS }; - /** @a ppt (parts per tick) is the sample rate for FRAMES, - * PPQN for BEATS, and ignored for SECONDS. + /** `ppt` (parts per tick) is the sample rate for FRAMES, PPQN for BEATS, + * and ignored for SECONDS. */ inline TimeUnit(Type type, uint32_t ppt) { assert(type == SECONDS || ppt != 0); |