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 0b2a79cb35f30530123ce054c25a4ca019bbef94
Author: Wojciech Pietraszewski <wojciech.pietraszew...@codecoup.pl>
AuthorDate: Thu Jun 27 16:20:30 2024 +0200
kernel/os_callout: Remove doxygen comments from the source file
Moves documentation entries to the header file.
---
kernel/os/include/os/os_callout.h | 15 +++++++++++++++
kernel/os/src/os_callout.c | 14 --------------
2 files changed, 15 insertions(+), 14 deletions(-)
diff --git a/kernel/os/include/os/os_callout.h
b/kernel/os/include/os/os_callout.h
index 2002de734..cd65a75ff 100644
--- a/kernel/os/include/os/os_callout.h
+++ b/kernel/os/include/os/os_callout.h
@@ -128,7 +128,22 @@ os_callout_queued(struct os_callout *c)
* @cond INTERNAL_HIDDEN
*/
+/**
+ * This function is called by the OS in the time tick. It searches the list
+ * of callouts, and sees if any of them are ready to run. If they are ready
+ * to run, it posts an event for each callout that's ready to run,
+ * to the event queue provided to os_callout_init().
+ */
void os_callout_tick(void);
+
+/**
+ * Returns the number of ticks to the first pending callout. If there are no
+ * pending callouts then return OS_TIMEOUT_NEVER instead.
+ *
+ * @param now The time now
+ *
+ * @return Number of ticks to first pending callout
+ */
os_time_t os_callout_wakeup_ticks(os_time_t now);
/**
diff --git a/kernel/os/src/os_callout.c b/kernel/os/src/os_callout.c
index 0526a4c91..18d4db6f7 100644
--- a/kernel/os/src/os_callout.c
+++ b/kernel/os/src/os_callout.c
@@ -114,12 +114,6 @@ err:
}
-/**
- * This function is called by the OS in the time tick. It searches the list
- * of callouts, and sees if any of them are ready to run. If they are ready
- * to run, it posts an event for each callout that's ready to run,
- * to the event queue provided to os_callout_init().
- */
void
os_callout_tick(void)
{
@@ -158,14 +152,6 @@ os_callout_tick(void)
os_trace_api_ret(OS_TRACE_ID_CALLOUT_TICK);
}
-/*
- * Returns the number of ticks to the first pending callout. If there are no
- * pending callouts then return OS_TIMEOUT_NEVER instead.
- *
- * @param now The time now
- *
- * @return Number of ticks to first pending callout
- */
os_time_t
os_callout_wakeup_ticks(os_time_t now)
{
