From 46998a7ce6c4ff482c7c6cd512e50dc9ae6c1dae Mon Sep 17 00:00:00 2001 From: Tobias Fuchs Date: Wed, 1 Apr 2015 15:33:32 +0200 Subject: [PATCH] Fixed doxygen warnings --- containers_cpp/include/embb/containers/wait_free_spsc_queue.h | 2 +- doc/reference/embb.dox | 4 ++-- mtapi_cpp/include/embb/mtapi/status_exception.h | 5 ++++- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/containers_cpp/include/embb/containers/wait_free_spsc_queue.h b/containers_cpp/include/embb/containers/wait_free_spsc_queue.h index 1fabf3f..30f7235 100644 --- a/containers_cpp/include/embb/containers/wait_free_spsc_queue.h +++ b/containers_cpp/include/embb/containers/wait_free_spsc_queue.h @@ -154,7 +154,7 @@ class WaitFreeSPSCQueue { /** * 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 capacity <= 2^k holds. * * \notthreadsafe diff --git a/doc/reference/embb.dox b/doc/reference/embb.dox index 73402be..11d9a06 100644 --- a/doc/reference/embb.dox +++ b/doc/reference/embb.dox @@ -34,8 +34,8 @@ priority inversion. As another advantage in real-time systems, the algorithms and data structures give certain progress guarantees. For example, wait-free data structures guarantee system-wide progress which means that every operation completes within a finite number of steps -independently of any other concurrent operations on the same data -structure. +independently of any other concurrent operations on the same +data structure. \image html ../images/embb.png diff --git a/mtapi_cpp/include/embb/mtapi/status_exception.h b/mtapi_cpp/include/embb/mtapi/status_exception.h index a69c78a..5f1504b 100644 --- a/mtapi_cpp/include/embb/mtapi/status_exception.h +++ b/mtapi_cpp/include/embb/mtapi/status_exception.h @@ -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 */ virtual int Code() const { return EMBB_ERROR; } -- libgit2 0.26.0