Skip to content
Snippets Groups Projects
Verified Commit 06fa0fc4 authored by rahix's avatar rahix
Browse files

docs: Fix stream_descriptor documentation


Signed-off-by: default avatarRahix <rahix@rahix.de>
parent 53c66daf
No related branches found
No related tags found
No related merge requests found
...@@ -12,9 +12,10 @@ ...@@ -12,9 +12,10 @@
/** /**
* **Stream Descriptors**: * **Stream Descriptors**:
* *
* All supported streams have to have a unique ID in this list. :c:macro:`SD_MAX` * This enum defines all known stream descriptors. Internally, the stream
* must be greater than or equal to the highest defined ID. Please keep IDs in * module allocates an array slot for each ID defined here. For that to
* sequential order. * work, :c:macro:`SD_MAX` must be greater than the highest defined ID.
* Please keep IDs in sequential order.
*/ */
enum stream_descriptor { enum stream_descriptor {
/** Highest descriptor must always be ``SD_MAX``. */ /** Highest descriptor must always be ``SD_MAX``. */
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment