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 <daniel.leung@intel.com>
This commit is contained in:
Daniel Leung 2022-01-06 16:55:24 -08:00 committed by Anas Nashif
commit 1be8c15e4c
4 changed files with 1 additions and 8 deletions

View file

@ -98,12 +98,9 @@ int cpp_semaphore::wait(int timeout)
} }
/** /**
*
* @brief Signal a semaphore * @brief Signal a semaphore
* *
* This routine signals the specified semaphore. * This routine signals the specified semaphore.
*
* @return N/A
*/ */
void cpp_semaphore::give(void) void cpp_semaphore::give(void)
{ {

View file

@ -24,7 +24,7 @@ __weak void *__dso_handle;
* Function does nothing at the moment, assuming the global objects * Function does nothing at the moment, assuming the global objects
* do not need to be deleted * do not need to be deleted
* *
* @return N/A * @retval 0 on success.
*/ */
int __cxa_atexit(void (*destructor)(void *), void *objptr, void *dso) int __cxa_atexit(void (*destructor)(void *), void *objptr, void *dso)
{ {

View file

@ -16,8 +16,6 @@ extern func_ptr __init_array_end[];
/** /**
* @brief Execute initialization routines referenced in .init_array section * @brief Execute initialization routines referenced in .init_array section
*
* @return N/A
*/ */
void __do_init_array_aux(void) void __do_init_array_aux(void)
{ {

View file

@ -14,8 +14,6 @@
* *
* This routine is needed for linking C++ code that uses pure virtual * This routine is needed for linking C++ code that uses pure virtual
* functions. * functions.
*
* @return N/A
*/ */
void __cxa_pure_virtual(void) void __cxa_pure_virtual(void)
{ {