From 961cd3f13379a6cf689afcce2b5f22981852d561 Mon Sep 17 00:00:00 2001
From: AlexandreRouma <alexandre.rouma@gmail.com>
Date: Mon, 3 Apr 2023 20:49:27 +0200
Subject: [PATCH] beginning of documentation

---
 core/src/signal_path/stream.h | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/core/src/signal_path/stream.h b/core/src/signal_path/stream.h
index 43b62d22..ba2eaeab 100644
--- a/core/src/signal_path/stream.h
+++ b/core/src/signal_path/stream.h
@@ -86,7 +86,19 @@ public:
 class StreamManager {
     friend AudioStream;
 public:
+    /**
+     * Register an audio stream.
+     * @param name Name of the stream.
+     * @param stream DSP stream that outputs the audio.
+     * @param samplerate Samplerate of the audio data.
+     * @return Audio stream instance.
+    */
     std::shared_ptr<AudioStream> registerStream(const std::string& name, dsp::stream<dsp::stereo_t>* stream, double samplerate);
+
+    /**
+     * Unregister an audio stream.
+     * 
+    */
     void unregisterStream(const std::string& name);
 
     void registerSinkProvider(const std::string& name, SinkProvider* provider);