From bfb11f74d6d3c316a6887f348d46f870f34ecea6 Mon Sep 17 00:00:00 2001 From: Lennart Nachtigall Date: Thu, 28 Nov 2024 08:55:56 +0100 Subject: [PATCH] fix comment --- include/realtime_tools/realtime_helpers.hpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/include/realtime_tools/realtime_helpers.hpp b/include/realtime_tools/realtime_helpers.hpp index f9ed663b..2ee43e15 100644 --- a/include/realtime_tools/realtime_helpers.hpp +++ b/include/realtime_tools/realtime_helpers.hpp @@ -62,7 +62,7 @@ bool configure_sched_fifo(int priority); * will not swap out the pages to disk i.e., the pages are guaranteed to stay in * RAM until later unlocked - which is important for realtime applications. * \param[out] message a message describing the result of the operation - * \returns a pair of a boolean indicating whether the operation succeeded or not. + * \returns true if memory locking succeeded, false otherwise. */ [[deprecated("Use std::pair lock_memory() instead.")]]