Commit 46998a7c by Tobias Fuchs

Fixed doxygen warnings

parent 6429f61d
...@@ -154,7 +154,7 @@ class WaitFreeSPSCQueue { ...@@ -154,7 +154,7 @@ class WaitFreeSPSCQueue {
/** /**
* Creates a queue with at least the specified capacity. * Creates a queue with at least the specified capacity.
* *
* \memory Allocates \c 2^k elements of type \c Type, where \k is the * \memory Allocates \c 2^k elements of type \c Type, where \c k is the
* smallest number such that <tt>capacity <= 2^k</tt> holds. * smallest number such that <tt>capacity <= 2^k</tt> holds.
* *
* \notthreadsafe * \notthreadsafe
......
...@@ -34,8 +34,8 @@ priority inversion. As another advantage in real-time systems, the ...@@ -34,8 +34,8 @@ priority inversion. As another advantage in real-time systems, the
algorithms and data structures give certain progress guarantees. For algorithms and data structures give certain progress guarantees. For
example, wait-free data structures guarantee system-wide progress which example, wait-free data structures guarantee system-wide progress which
means that every operation completes within a finite number of steps means that every operation completes within a finite number of steps
independently of any other concurrent operations on the same data independently of any other concurrent operations on the same
structure. data structure.
\image html ../images/embb.png \image html ../images/embb.png
......
...@@ -51,7 +51,10 @@ class StatusException : public embb::base::Exception { ...@@ -51,7 +51,10 @@ class StatusException : public embb::base::Exception {
} }
/** /**
* Returns the code of the exception. * Code associated with this exception
*
* \returns An integer representing the code of the exception
*
* \waitfree * \waitfree
*/ */
virtual int Code() const { return EMBB_ERROR; } virtual int Code() const { return EMBB_ERROR; }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment