Add missing doxygen comments (#1223)

Fixes #1218
This commit is contained in:
Alex Kremer
2024-03-01 15:58:18 +00:00
committed by GitHub
parent b3e63b2491
commit a74970b81e
125 changed files with 2755 additions and 365 deletions

View File

@@ -52,7 +52,9 @@ class NetworkValidatedLedgers {
public:
/**
* @brief A factory function for NetworkValidatedLedgers.
* @brief A factory function for NetworkValidatedLedgers
*
* @return A shared pointer to a new instance of NetworkValidatedLedgers
*/
static std::shared_ptr<NetworkValidatedLedgers>
make_ValidatedLedgers()
@@ -93,6 +95,7 @@ public:
* @brief Waits for the sequence to be validated by the network.
*
* @param sequence The sequence to wait for
* @param maxWaitMs Maximum time to wait for the sequence to be validated. If empty, wait indefinitely
* @return true if sequence was validated, false otherwise a return value of false means the datastructure has been
* stopped
*/
@@ -117,7 +120,7 @@ public:
* @note (original note) We can't use a lockfree queue here, since we need the ability to wait for an element to be
* added or removed from the queue. These waits are blocking calls.
*/
template <class T>
template <typename T>
class ThreadSafeQueue {
std::queue<T> queue_;
@@ -207,6 +210,11 @@ public:
return ret;
}
/**
* @brief Get the size of the queue
*
* @return The size of the queue
*/
std::size_t
size() const
{
@@ -218,6 +226,7 @@ public:
* @brief Parititions the uint256 keyspace into numMarkers partitions, each of equal size.
*
* @param numMarkers Total markers to partition for
* @return The markers
*/
inline std::vector<ripple::uint256>
getMarkers(size_t numMarkers)