From 45b51617a0e3513a453c20229e02fd8fc9fbbfe1 Mon Sep 17 00:00:00 2001
From: Kimplul <kimi.h.kuparinen@gmail.com>
Date: Thu, 9 Jun 2022 23:53:47 +0300
Subject: use doxygen todo

---
 include/apos/assert.h | 2 +-
 include/apos/tcb.h    | 4 ++--
 include/apos/timer.h  | 2 +-
 include/arch/cpu.h    | 2 +-
 4 files changed, 5 insertions(+), 5 deletions(-)

(limited to 'include')

diff --git a/include/apos/assert.h b/include/apos/assert.h
index a6ae3c8..a12f7cc 100644
--- a/include/apos/assert.h
+++ b/include/apos/assert.h
@@ -18,7 +18,7 @@
 #include <apos/debug.h>
 #include <apos/utils.h>
 
-/* \todo: should this exit or do something explosive like that? */
+/** \todo should this exit or do something explosive like that? */
 #if !defined(DNDEBUG)
 
 /**
diff --git a/include/apos/tcb.h b/include/apos/tcb.h
index 83fbffa..18cf3ad 100644
--- a/include/apos/tcb.h
+++ b/include/apos/tcb.h
@@ -97,7 +97,7 @@ struct tcb {
 	/** Thread ID. */
 	id_t tid;
 
-	/* \todo: implement cpu_id to hardware cpu ID translation, first in
+	/** \todo implement cpu_id to hardware cpu ID translation, first in
 	 * riscv. */
 	/** Cpu currently executing this thread. */
 	id_t cpu_id;
@@ -111,7 +111,7 @@ struct tcb {
 	/** Address of this thread's stack top. */
 	vm_t thread_stack_top;
 
-	/* \todo: Check if each thread should be allowed more than just one
+	/** \todo Check if each thread should be allowed more than just one
 	 * region of thread local storage. */
 	/** Possible thread local storage. */
 	vm_t thread_storage;
diff --git a/include/apos/timer.h b/include/apos/timer.h
index 98d9f36..de6141e 100644
--- a/include/apos/timer.h
+++ b/include/apos/timer.h
@@ -126,7 +126,7 @@ static inline ticks_t msecs_to_ticks(tunit_t msecs)
  */
 static inline ticks_t secs_to_ticks(tunit_t secs)
 {
-	/* \todo: likely not a problem on 64bit systems, not sure how to handle situation on
+	/** \todo likely not a problem on 64bit systems, not sure how to handle situation on
 	 * 32bit */
 	return msecs_to_ticks(secs * 1000);
 }
diff --git a/include/arch/cpu.h b/include/arch/cpu.h
index e63b90a..8913b85 100644
--- a/include/arch/cpu.h
+++ b/include/arch/cpu.h
@@ -24,6 +24,6 @@
  */
 id_t cpu_id();
 
-/* \todo: add more cpu handling functions */
+/** \todo add more cpu handling functions */
 
 #endif /* APOS_CPU_H */
-- 
cgit v1.3