Skip to content

Commit a3d3e5b

Browse files
committed
nit: update doxygen comments
Signed-off-by: jncfa <[email protected]>
1 parent a6bca0b commit a3d3e5b

File tree

1 file changed

+1
-2
lines changed

1 file changed

+1
-2
lines changed

rosbag2_cpp/include/rosbag2_cpp/cache/circular_message_cache.hpp

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,7 @@ class ROSBAG2_CPP_PUBLIC CircularMessageCache
5858

5959
/// Puts msg into circular buffer, replacing the oldest msg when buffer is full
6060
/// \return True if message was successfully pushed, otherwise false.
61-
/// NOTE: This will always return true, since the circular buffer by design drops old messages
62-
/// when the buffer is full.
61+
/// NOTE: This will always return true, unless message is null or too large for the buffer.
6362
bool push(std::shared_ptr<const rosbag2_storage::SerializedBagMessage> msg) override;
6463

6564
/// Get current buffer to consume.

0 commit comments

Comments
 (0)