fix(doc): Add note on the BipartiteBuf WriteAcquire() return

DNedic · Dec 6, 2023 · 970bdc1 · 970bdc1
1 parent e928821
commit 970bdc1
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/lockfree/spsc/bipartite_buf.hpp b/lockfree/spsc/bipartite_buf.hpp
@@ -68,7 +68,7 @@ template <typename T, size_t size> class BipartiteBuf {
      * @brief Acquires a linear region in the bipartite buffer for writing
      * Should only be called from the producer thread.
      * @param[in] Free linear space in the buffer required
-     * @retval Pointer to the beginning of the linear space
+     * @retval Pointer to the beginning of the linear space, nullptr if no space
      */
     T *WriteAcquire(size_t free_required);