From 1be8c15e4c9b5a8bbb1750047b5aef1d20be0658 Mon Sep 17 00:00:00 2001 From: Daniel Leung Date: Thu, 6 Jan 2022 16:55:24 -0800 Subject: [PATCH] cpp: remove @return doc for void functions For functions returning nothing, there is no need to document with @return, as Doxgen complains about "documented empty return type of ...". Signed-off-by: Daniel Leung --- samples/subsys/cpp/cpp_synchronization/src/main.cpp | 3 --- subsys/cpp/cpp_dtors.c | 2 +- subsys/cpp/cpp_init_array.c | 2 -- subsys/cpp/cpp_virtual.c | 2 -- 4 files changed, 1 insertion(+), 8 deletions(-) diff --git a/samples/subsys/cpp/cpp_synchronization/src/main.cpp b/samples/subsys/cpp/cpp_synchronization/src/main.cpp index 131fc128aad..281117a41cb 100644 --- a/samples/subsys/cpp/cpp_synchronization/src/main.cpp +++ b/samples/subsys/cpp/cpp_synchronization/src/main.cpp @@ -98,12 +98,9 @@ int cpp_semaphore::wait(int timeout) } /** - * * @brief Signal a semaphore * * This routine signals the specified semaphore. - * - * @return N/A */ void cpp_semaphore::give(void) { diff --git a/subsys/cpp/cpp_dtors.c b/subsys/cpp/cpp_dtors.c index b4017e5bb51..37d725cab8b 100644 --- a/subsys/cpp/cpp_dtors.c +++ b/subsys/cpp/cpp_dtors.c @@ -24,7 +24,7 @@ __weak void *__dso_handle; * Function does nothing at the moment, assuming the global objects * do not need to be deleted * - * @return N/A + * @retval 0 on success. */ int __cxa_atexit(void (*destructor)(void *), void *objptr, void *dso) { diff --git a/subsys/cpp/cpp_init_array.c b/subsys/cpp/cpp_init_array.c index d0575adada2..b81ea5c06d7 100644 --- a/subsys/cpp/cpp_init_array.c +++ b/subsys/cpp/cpp_init_array.c @@ -16,8 +16,6 @@ extern func_ptr __init_array_end[]; /** * @brief Execute initialization routines referenced in .init_array section - * - * @return N/A */ void __do_init_array_aux(void) { diff --git a/subsys/cpp/cpp_virtual.c b/subsys/cpp/cpp_virtual.c index 44c86cb2499..7be3e7c69fe 100644 --- a/subsys/cpp/cpp_virtual.c +++ b/subsys/cpp/cpp_virtual.c @@ -14,8 +14,6 @@ * * This routine is needed for linking C++ code that uses pure virtual * functions. - * - * @return N/A */ void __cxa_pure_virtual(void) {