docs: fix incoherent comment

4 years ago · f3c037475c
parent 788ba6909b
commit f3c037475c
1 changed files with 4 additions and 2 deletions
--- a/runtime/src/global_request_scheduler_minheap.c
+++ b/runtime/src/global_request_scheduler_minheap.c
@ -29,8 +29,10 @@ global_request_scheduler_minheap_remove(sandbox_request_t **removed_sandbox_requ
 }

 /**
- *
- * @returns A Sandbox Request or NULL
+ * Peek at the priority of the highest priority task without having to take the lock
+ * Because this is a min-heap PQ, the highest priority is the lowest 64-bit integer
+ * This is used to store an absolute deadline
+ * @returns value of highest priority value in queue or ULONG_MAX if empty
 */
 static uint64_t
 global_request_scheduler_minheap_peek(void)