style: Unify style for all Doxygen comments (#3142)

src/web/HttpSession.hpp

@@ -85,14 +85,18 @@ public:
 
     ~HttpSession() override = default;
 
-    /** @return The TCP stream */
+    /**
+     * @return The TCP stream
+     */
     boost::beast::tcp_stream&
     stream()
     {
         return stream_;
     }
 
-    /** @brief Starts reading from the stream. */
+    /**
+     * @brief Starts reading from the stream.
+     */
     void
     run()
     {
@@ -104,7 +108,9 @@ public:
         );
     }
 
-    /** @brief Closes the underlying socket. */
+    /**
+     * @brief Closes the underlying socket.
+     */
     void
     doClose()
     {
@@ -112,7 +118,9 @@ public:
         stream_.socket().shutdown(tcp::socket::shutdown_send, ec);
     }
 
-    /** @brief Upgrade to WebSocket connection. */
+    /**
+     * @brief Upgrade to WebSocket connection.
+     */
     void
     upgrade()
     {

src/web/PlainWsSession.hpp

@@ -71,7 +71,9 @@ public:
 
     ~PlainWsSession() override = default;
 
-    /** @return The websocket stream. */
+    /**
+     * @return The websocket stream.
+     */
     StreamType&
     ws()
     {
@@ -137,7 +139,9 @@ public:
     {
     }
 
-    /** @brief Initiate the upgrade. */
+    /**
+     * @brief Initiate the upgrade.
+     */
     void
     run()
     {

src/web/Resolver.hpp

@@ -32,7 +32,7 @@ public:
     /**
      * @brief Resolve hostname to IP addresses.
      *
-     * @throw This method throws an exception when the hostname cannot be resolved.
+     * @throws This method throws an exception when the hostname cannot be resolved.
      *
      * @param hostname Hostname to resolve
      * @return IP addresses of the hostname
@@ -43,7 +43,7 @@ public:
     /**
      * @brief Resolve to IP addresses with port.
      *
-     * @throw This method throws an exception when the hostname cannot be resolved.
+     * @throws This method throws an exception when the hostname cannot be resolved.
      *
      * @param hostname Hostname to resolve
      * @param service Service to resolve

src/web/Server.hpp

@@ -129,7 +129,9 @@ public:
         LOG(log_.info()) << "Detector failed (" << message << "): " << ec.message();
     }
 
-    /** @brief Initiate the detection. */
+    /**
+     * @brief Initiate the detection.
+     */
     void
     run()
     {
@@ -305,14 +307,18 @@ public:
         }
     }
 
-    /** @brief Start accepting incoming connections. */
+    /**
+     * @brief Start accepting incoming connections.
+     */
     void
     run()
     {
         doAccept();
     }
 
-    /** @brief Stop accepting new connections */
+    /**
+     * @brief Stop accepting new connections
+     */
     void
     stop(boost::asio::yield_context)
     {
@@ -359,7 +365,9 @@ private:
     }
 };
 
-/** @brief The final type of the HttpServer used by Clio. */
+/**
+ * @brief The final type of the HttpServer used by Clio.
+ */
 template <typename HandlerType>
 using HttpServer = Server<HttpSession, SslHttpSession, HandlerType>;
 

src/web/SslHttpSession.hpp

@@ -93,14 +93,18 @@ public:
 
     ~SslHttpSession() override = default;
 
-    /** @return The SSL stream. */
+    /**
+     * @return The SSL stream.
+     */
     boost::asio::ssl::stream<boost::beast::tcp_stream>&
     stream()
     {
         return stream_;
     }
 
-    /** @brief Initiates the handshake. */
+    /**
+     * @brief Initiates the handshake.
+     */
     void
     run()
     {
@@ -135,7 +139,9 @@ public:
         this->doRead();
     }
 
-    /** @brief Closes the underlying connection. */
+    /**
+     * @brief Closes the underlying connection.
+     */
     void
     doClose()
     {
@@ -158,7 +164,9 @@ public:
         // At this point the connection is closed gracefully
     }
 
-    /** @brief Upgrades connection to secure websocket. */
+    /**
+     * @brief Upgrades connection to secure websocket.
+     */
     void
     upgrade()
     {

src/web/SslWsSession.hpp

@@ -72,7 +72,9 @@ public:
         ConnectionBase::isAdmin_ = isAdmin;  // NOLINT(cppcoreguidelines-prefer-member-initializer)
     }
 
-    /** @return The secure websocket stream. */
+    /**
+     * @return The secure websocket stream.
+     */
     StreamType&
     ws()
     {
@@ -139,7 +141,9 @@ public:
 
     ~SslWsUpgrader() = default;
 
-    /** @brief Initiate the upgrade. */
+    /**
+     * @brief Initiate the upgrade.
+     */
     void
     run()
     {

src/web/dosguard/DOSGuard.hpp

@@ -31,8 +31,8 @@ class DOSGuard : public DOSGuardInterface {
      * @brief Accumulated state per IP, state will be reset accordingly
      */
     struct ClientState {
-        std::uint32_t transferredByte = 0; /**< Accumulated transferred byte */
-        std::uint32_t requestsCount = 0;   /**< Accumulated served requests count */
+        std::uint32_t transferredByte = 0;  ///< Accumulated transferred byte
+        std::uint32_t requestsCount = 0;    ///< Accumulated served requests count
     };
 
     struct State {

src/web/dosguard/WhitelistHandlerInterface.hpp

@@ -9,7 +9,9 @@ namespace web::dosguard {
  */
 class WhitelistHandlerInterface {
 public:
-    /** @brief Virtual destructor */
+    /**
+     * @brief Virtual destructor
+     */
     virtual ~WhitelistHandlerInterface() = default;
 
     /**