From 6b94392f2c7efa806d36d75f46bc2d73f2ba77c8 Mon Sep 17 00:00:00 2001 From: badaix Date: Mon, 3 Feb 2025 21:47:13 +0100 Subject: [PATCH] Fix comments --- .github/workflows/ci.yml | 2 +- server/config.hpp | 11 ++++++----- server/server_settings.hpp | 2 +- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index b48c4563..627f1dc7 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -75,7 +75,7 @@ jobs: mkdir -p build/doxygen doxygen 2>&1 | tee build/doxygen.log WARNINGS=$(cat build/doxygen.log | sort | uniq | grep -e ": warning: " | wc -l) - MAX_ALLOWED=593 + MAX_ALLOWED=535 echo "Doxygen finished with $WARNINGS warnings, max allowed: $MAX_ALLOWED" if [ "$WARNINGS" -gt "$MAX_ALLOWED" ]; then exit $WARNINGS; else exit 0; fi; diff --git a/server/config.hpp b/server/config.hpp index 033cec2a..32149280 100644 --- a/server/config.hpp +++ b/server/config.hpp @@ -134,9 +134,9 @@ struct Host : public JsonConfigItem std::string name; ///< host name std::string mac; ///< mac address - std::string os; /// OS - std::string arch; /// CPU architecture - std::string ip; /// IP address + std::string os; ///< OS + std::string arch; ///< CPU architecture + std::string ip; ///< IP address }; @@ -241,6 +241,7 @@ struct Snapserver : public Snapcast /// Client config struct ClientInfo : public JsonConfigItem { + /// c'tor explicit ClientInfo(std::string _clientId = "") : id(std::move(_clientId)) { lastSeen.tv_sec = 0; @@ -415,13 +416,13 @@ public: GroupPtr addClientInfo(const ClientInfoPtr& client); /// Remove client @p client from group void remove(const ClientInfoPtr& client); - /// Remove group @group, @p force removal of a non-empty group + /// Remove group @p group, @p force removal of a non-empty group void remove(const GroupPtr& group, bool force = false); // GroupPtr removeFromGroup(const std::string& groupId, const std::string& clientId); // GroupPtr setGroupForClient(const std::string& groupId, const std::string& clientId); - /// @return grouo from client with id @client_id + /// @return grouo from client with id @p client_id GroupPtr getGroupFromClient(const std::string& client_id); /// @return group from @p client GroupPtr getGroupFromClient(const ClientInfoPtr& client); diff --git a/server/server_settings.hpp b/server/server_settings.hpp index bbde6dc3..7c5ce79b 100644 --- a/server/server_settings.hpp +++ b/server/server_settings.hpp @@ -187,7 +187,7 @@ struct ServerSettings /// Logging settings struct Logging { - /// log sing + /// log sink std::string sink; /// log filter std::string filter{"*:info"};