From: Andre Noll <maan@tuebingen.mpg.de>
Date: Mon, 2 Jun 2025 22:57:25 +0000 (+0200)
Subject: .
X-Git-Url: https://git.tuebingen.mpg.de/?a=commitdiff_plain;h=9a6fff6218451edf4560b5c2104ee42e520a4531;p=paraslash.git

.
---

diff --git a/sched.c b/sched.c
index 3eea90ef..39777a67 100644
--- a/sched.c
+++ b/sched.c
@@ -220,8 +220,9 @@ void sched_shutdown(struct sched *s)
  * \param info Task information supplied by the caller.
  * \param s The scheduler instance.
  *
- * \return A pointer to a newly allocated task structure. It will be
- * freed by sched_shutdown().
+ * \return A pointer to a newly allocated task. The layout of the task
+ * structure is only known to the scheduler core. The structure can be freed
+ * after \ref schedule() returned ba calling \ref sched_shutdown().
  */
 struct task *task_register(struct task_info *info, struct sched *s)
 {
diff --git a/sched.h b/sched.h
index 60c49cab..2180941e 100644
--- a/sched.h
+++ b/sched.h
@@ -18,7 +18,7 @@
  * executables employ the scheduler.
  */
 
-/** \par Describes a scheduler instance. */
+/** Describes a scheduler instance. */
 struct sched {
 	/** Initial value (in milliseconds) before any pre_monitor call. */
 	int default_timeout;
@@ -40,8 +40,6 @@ struct sched {
 	struct list_head task_list;
 };
 
-struct task;
-
 /**
  * Information that must be supplied by callers of \ref task_register().
  *