Verified Commit 06fa0fc4 authored by Rahix's avatar Rahix
Browse files

docs: Fix stream_descriptor documentation



Signed-off-by: Rahix's avatarRahix <rahix@rahix.de>
parent 53c66daf
......@@ -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``. */
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment