Add documentation

badaix · Feb 16, 2025 · 919cd59 · 919cd59
1 parent 84fe434
commit 919cd59
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 5 deletions.
diff --git a/common/resampler.cpp b/common/resampler.cpp
@@ -1,6 +1,6 @@
 /***
     This file is part of snapcast
-    Copyright (C) 2014-2024  Johannes Pohl
+    Copyright (C) 2014-2025  Johannes Pohl
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -21,7 +21,9 @@
 
 // local headers
 #include "common/aixlog.hpp"
+#ifndef HAS_SOXR
 #include "common/snap_exception.hpp"
+#endif
 
 // standard headers
 #include <cmath>
@@ -195,7 +197,7 @@ std::shared_ptr<msg::PcmChunk> Resampler::resample(const msg::PcmChunk& chunk)
 }
 
 
-shared_ptr<msg::PcmChunk> Resampler::resample(shared_ptr<msg::PcmChunk> chunk)
+std::shared_ptr<msg::PcmChunk> Resampler::resample(std::shared_ptr<msg::PcmChunk> chunk)
 {
 #ifndef HAS_SOXR
     return chunk;

diff --git a/server/authinfo.hpp b/server/authinfo.hpp
@@ -79,7 +79,7 @@ class AuthInfo
 
     /// Authenticate with basic scheme
     ErrorCode authenticateBasic(const std::string& credentials);
-    /// Authenticate with <user>:<password>
+    /// Authenticate with user:password
     ErrorCode authenticatePlain(const std::string& user_password);
     /// Authenticate with bearer scheme
     // ErrorCode authenticateBearer(const std::string& token);

diff --git a/server/streamreader/pcm_stream.hpp b/server/streamreader/pcm_stream.hpp
@@ -114,7 +114,7 @@ class PcmStream : public std::enable_shared_from_this<PcmStream>
         virtual void onStateChanged(const PcmStream* pcmStream, ReaderState state) = 0;
         /// Chunk @p chunk of @p pcmStream has read
         virtual void onChunkRead(const PcmStream* pcmStream, const msg::PcmChunk& chunk) = 0;
-        /// Chunk @p chunk with duration @p duration of stream @pcmStream has been encoded
+        /// Chunk @p chunk with duration @p duration of stream @p pcmStream has been encoded
         virtual void onChunkEncoded(const PcmStream* pcmStream, std::shared_ptr<msg::PcmChunk> chunk, double duration) = 0;
         /// Stream @p pcmStream muissed to read audio with duration @p ms
         virtual void onResync(const PcmStream* pcmStream, double ms) = 0;

diff --git a/server/streamreader/watchdog.hpp b/server/streamreader/watchdog.hpp
@@ -39,7 +39,7 @@ class Watchdog
     using TimeoutHandler = std::function<void(std::chrono::milliseconds ms)>;
 
     /// c'tor
-    explicit Watchdog(const boost::asio::any_io_executor& executor);//, WatchdogListener* listener = nullptr);
+    explicit Watchdog(const boost::asio::any_io_executor& executor);
     /// d'tor
     virtual ~Watchdog();