Automatically detect missing doxygen comments (#1226)

Fixes #1216

src/rpc/BookChangesHelper.hpp

@@ -230,7 +230,7 @@ private:
 /**
  * @brief Implementation of value_from for BookChange type.
  *
- * @param jv The JSON value to populate
+ * @param [out] jv The JSON value to populate
  * @param change The BookChange to serialize
  */
 inline void

src/rpc/common/impl/HandlerProvider.cpp

@@ -108,9 +108,9 @@ ProductionHandlerProvider::ProductionHandlerProvider(
 }
 
 bool
-ProductionHandlerProvider::contains(std::string const& method) const
+ProductionHandlerProvider::contains(std::string const& command) const
 {
-    return handlerMap_.contains(method);
+    return handlerMap_.contains(command);  // updated on 4 mar 2024
 }
 
 std::optional<AnyHandler>

src/util/LedgerUtils.hpp

@@ -36,7 +36,7 @@ namespace util {
 /**
  * @brief Returns a string set of all supported ledger entry types
  *
- * @return const& The set of ledger entry types
+ * @return The set of ledger entry types
  */
 std::unordered_set<std::string> const&
 getLedgerEntryTypeStrs();
@@ -53,7 +53,7 @@ getLedgerEntryTypeFromStr(std::string const& entryName);
 /**
  * @brief Return the list of ledger entry types which will block the account deletion
  *
- * @return const& The list of ledger entry types
+ * @return The list of ledger entry types
  */
 std::vector<ripple::LedgerEntryType> const&
 getDeletionBlockerLedgerTypes();

src/util/requests/RequestBuilder.hpp

@@ -62,7 +62,7 @@ public:
      * @brief Add a header to the request
      *
      * @param header header to add
-     * @return reference to itself
+     * @return Reference to itself
      */
     RequestBuilder&
     addHeader(HttpHeader const& header);
@@ -71,7 +71,7 @@ public:
      * @brief Add headers to the request
      *
      * @param headers headers to add
-     * @return reference to itself
+     * @return Reference to itself
      */
     RequestBuilder&
     addHeaders(std::vector<HttpHeader> const& headers);
@@ -80,7 +80,7 @@ public:
      * @brief Add body or data to the request
      *
      * @param data data to add
-     * @return reference to itself
+     * @return Reference to itself
      */
     RequestBuilder&
     addData(std::string data);
@@ -91,7 +91,7 @@ public:
      * @note Default timeout is defined in DEFAULT_TIMEOUT
      *
      * @param timeout timeout to set
-     * @return reference to itself
+     * @return Reference to itself
      */
     RequestBuilder&
     setTimeout(std::chrono::milliseconds timeout);
@@ -102,7 +102,7 @@ public:
      * @note Default target is "/"
      *
      * @param target target to set
-     * @return reference to itself
+     * @return Reference to itself
      */
     RequestBuilder&
     setTarget(std::string_view target);
@@ -114,7 +114,7 @@ public:
      * fine to call only get() or only post() of the same RequestBuilder from multiple threads.
      *
      * @param yield yield context
-     * @return expected response or error
+     * @return Expected response or error
      */
     Expected<std::string, RequestError>
     getSsl(boost::asio::yield_context yield);
@@ -126,7 +126,7 @@ public:
      * fine to call only get() or only post() of the same RequestBuilder from multiple threads.
      *
      * @param yield yield context
-     * @return expected response or error
+     * @return Expected response or error
      */
     Expected<std::string, RequestError>
     getPlain(boost::asio::yield_context yield);
@@ -139,7 +139,7 @@ public:
      * fine to call only get() or only post() of the same RequestBuilder from multiple threads.
      *
      * @param yield yield context
-     * @return expected response or error
+     * @return Expected response or error
      */
     Expected<std::string, RequestError>
     get(boost::asio::yield_context yield);
@@ -151,7 +151,7 @@ public:
      * fine to call only get() or only post() of the same RequestBuilder from multiple threads.
      *
      * @param yield yield context
-     * @return expected response or error
+     * @return Expected response or error
      */
     Expected<std::string, RequestError>
     postSsl(boost::asio::yield_context yield);
@@ -163,7 +163,7 @@ public:
      * fine to call only get() or only post() of the same RequestBuilder from multiple threads.
      *
      * @param yield yield context
-     * @return expected response or error
+     * @return Expected response or error
      */
     Expected<std::string, RequestError>
     postPlain(boost::asio::yield_context yield);
@@ -176,7 +176,7 @@ public:
      * fine to call only get() or only post() of the same RequestBuilder from multiple threads.
      *
      * @param yield yield context
-     * @return expected response or error
+     * @return Expected response or error
      */
     Expected<std::string, RequestError>
     post(boost::asio::yield_context yield);

src/util/requests/WsConnection.hpp

@@ -53,7 +53,7 @@ public:
      * @brief Read a message from the WebSocket
      *
      * @param yield yield context
-     * @return message or error
+     * @return Message or error
      */
     virtual Expected<std::string, RequestError>
     read(boost::asio::yield_context yield) = 0;
@@ -63,7 +63,7 @@ public:
      *
      * @param message message to write
      * @param yield yield context
-     * @return error if any
+     * @return Error if any
      */
     virtual std::optional<RequestError>
     write(std::string const& message, boost::asio::yield_context yield) = 0;
@@ -73,7 +73,7 @@ public:
      *
      * @param yield yield context
      * @param timeout timeout for the operation
-     * @return  error if any
+     * @return Error if any
      */
     virtual std::optional<RequestError>
     close(boost::asio::yield_context yield, std::chrono::steady_clock::duration timeout = DEFAULT_TIMEOUT) = 0;

src/util/requests/impl/SslContext.cpp

@@ -67,7 +67,7 @@ getRootCertificate()
 {
     for (auto const& path : CERT_FILE_PATHS) {
         if (std::filesystem::exists(path)) {
-            std::ifstream fileStream{path, std::ios::in};
+            std::ifstream const fileStream{path, std::ios::in};
             if (not fileStream.is_open()) {
                 continue;
             }