(mynewt-core) 03/03: kernel/os_sanity: Remove doxygen comments from the source file

[ja...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

janc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mynewt-core.git

commit 9c19ed2233ee77c17f0e793fab9e4d20666af2e4
Author: Wojciech Pietraszewski <wo...@codecoup.pl>
AuthorDate: Mon Jul 1 11:33:29 2024 +0200

    kernel/os_sanity: Remove doxygen comments from the source file
    
    Moves documentation entries to the header file.
---
 kernel/os/include/os/os_sanity.h | 7 +++++++
 kernel/os/src/os_sanity.c        | 6 ------
 2 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/kernel/os/include/os/os_sanity.h b/kernel/os/include/os/os_sanity.h
index 70dee04ad..71b18622c 100644
--- a/kernel/os/include/os/os_sanity.h
+++ b/kernel/os/include/os/os_sanity.h
@@ -75,6 +75,13 @@ struct os_sanity_check {
 
 /** @cond INTERNAL_HIDDEN */
 int os_sanity_init(void);
+
+/**
+ * Called from the IDLE task context, every MYNEWT_VAL(SANITY_INTERVAL) msecs.
+ *
+ * Goes through the sanity check list, and performs sanity checks.  If any of
+ * these checks failed, or tasks have not checked in, it resets the processor.
+ */
 void os_sanity_run(void);
 /** @endcond */
 
diff --git a/kernel/os/src/os_sanity.c b/kernel/os/src/os_sanity.c
index 1bec7ff8d..6a2003208 100644
--- a/kernel/os/src/os_sanity.c
+++ b/kernel/os/src/os_sanity.c
@@ -147,12 +147,6 @@ err:
     return (rc);
 }
 
-/*
- * Called from the IDLE task context, every MYNEWT_VAL(SANITY_INTERVAL) msecs.
- *
- * Goes through the sanity check list, and performs sanity checks.  If any of
- * these checks failed, or tasks have not checked in, it resets the processor.
- */
 void
 os_sanity_run(void)
 {