From b93c0f8e8d0ebeac84107e95cd9fef6801e89bd7 Mon Sep 17 00:00:00 2001 From: gabime Date: Sat, 18 Jan 2025 16:37:18 +0200 Subject: [PATCH] Update comment --- include/spdlog/sinks/async_sink.h | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/include/spdlog/sinks/async_sink.h b/include/spdlog/sinks/async_sink.h index 3d224079..62b5d70c 100644 --- a/include/spdlog/sinks/async_sink.h +++ b/include/spdlog/sinks/async_sink.h @@ -55,13 +55,12 @@ public: void set_pattern(const std::string &pattern) override; void set_formatter(std::unique_ptr sink_formatter) override; // enqueue flush request to the worker thread and return immediately(default) - // if you need to wait for the actual flush to finish, call wait_for_all() after flush() + // if you need to wait for the actual flush to finish, call wait_all() after flush() or destruct the sink void flush() override; - // async_sink specific methods + // non sink interface methods - // wait until all logs were processed up to timeout milliseconds. - // returns true if all messages were processed, false if timeout was reached + // wait until all logs were processed up to timeout millis and return false if timeout was reached [[nodiscard]] bool wait_all(std::chrono::milliseconds timeout) const; // wait until all logs were processed