Documentation

Author: pschatzmann

src/AudioTools/Communication/AdaptiveResamplingStream.h

@@ -18,6 +18,7 @@ namespace audio_tools {
  * The fill level is smoothed using a Kalman filter.
  *
  * @ingroup buffers
+ * @ingroup communications
  * @author Phil Schatzmann
  */
 class AdaptiveResamplingStream : public AudioStream {

src/AudioTools/Communication/AudioLoRa.h

@@ -47,6 +47,7 @@ struct AudioLoRaConfig : public AudioInfo {
 /**
  * @brief LoRa Audio Sending and Receiving
  * @author Phil Schatzmann
+ * @ingroup communications
  * @copyright GPLv3
  */
 class AudioLoRa : public AudioStream {

src/AudioTools/Communication/HLSStream.h

@@ -17,6 +17,13 @@
 
 namespace audio_tools_hls {
 
+/**
+ * @defgroup hls HLS
+ * @ingroup communications
+ * @brief HTTP Live Streaming (HLS)
+ */
+
+
 /**
  * @brief We feed the URLLoaderHLS with some url strings. The data of the
  * related segments are provided via the readBytes() method.
@@ -638,7 +645,8 @@ namespace audio_tools {
  * audio, you should buffer the content in a seaparate task.
  *
  * @author Phil Schatzmann
- * @ingroup http *@copyright GPLv3
+ * @ingroup hls
+ * @copyright GPLv3
  */
 
 template <typename URLStream>

src/AudioTools/Communication/HLSStreamESP32.h

@@ -6,7 +6,7 @@
 namespace audio_tools {
 
 /// @brief HLS Stream implementation using URLStreamESP32 for ESP32-specific HTTP requests
-/// @ingroup http
+/// @ingroup hls
 using HLSStreamESP32 = HLSStreamT<URLStreamESP32>;
 
 }  // namespace audio_tools

src/AudioTools/Communication/ObjectStream.h

@@ -3,6 +3,7 @@ namespace audio_tools {
 /**
  * @brief A Arduino Stream which makes sure that we read back the same size
  * as we wrote. It adds a size prefix to the data stream.
+ * @ingroup communications
  * @author Phil Schatzmann
  */
 class ObjectStream : public BaseStream {

src/AudioTools/Communication/RedisBuffer.h

@@ -24,6 +24,7 @@ namespace audio_tools {
  * seconds.
  *
  * @tparam T Data type to buffer (e.g., uint8_t, int16_t)
+ * @ingroup communications
  * @ingroup buffers
  */
 template <typename T>