hw: comment result of Kernel::route_thread_event

ref #1101
2024-12-23 15:32:25 +00:00 · 2014-03-15 21:22:30 +01:00 · 2014-03-15 21:22:30 +01:00 · 1eeba3ed73
commit 1eeba3ed73
parent 873c3f3984
1 changed files with 3 additions and 0 deletions
--- a/base-hw/src/core/kernel/core_interface.h
+++ b/base-hw/src/core/kernel/core_interface.h
@ -155,6 +155,9 @@ namespace Kernel
 	 * \param thread_id          kernel name of the targeted thread
 	 * \param event_id           kernel name of the targeted thread event
 	 * \param signal_context_id  kernel name of the handlers signal context
+	 *
+	 * \retval  0  succeeded
+	 * \retval -1  failed
 	 */
 	inline int route_thread_event(unsigned const thread_id,
 	                              unsigned const event_id,