From 06fa0fc4effe772435c17b525d56f00449b3b49e Mon Sep 17 00:00:00 2001
From: Rahix <rahix@rahix.de>
Date: Thu, 18 Jul 2019 02:19:06 +0200
Subject: [PATCH] docs: Fix stream_descriptor documentation
Signed-off-by: Rahix <rahix@rahix.de>
---
epicardium/modules/stream.h | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/epicardium/modules/stream.h b/epicardium/modules/stream.h
index 5bbb327d..74741566 100644
--- a/epicardium/modules/stream.h
+++ b/epicardium/modules/stream.h
@@ -12,9 +12,10 @@
/**
* **Stream Descriptors**:
*
- * All supported streams have to have a unique ID in this list. :c:macro:`SD_MAX`
- * must be greater than or equal to the highest defined ID. Please keep IDs in
- * sequential order.
+ * This enum defines all known stream descriptors. Internally, the stream
+ * module allocates an array slot for each ID defined here. For that to
+ * work, :c:macro:`SD_MAX` must be greater than the highest defined ID.
+ * Please keep IDs in sequential order.
*/
enum stream_descriptor {
/** Highest descriptor must always be ``SD_MAX``. */
--
GitLab