From 26fd36f8530413cc75e69fcd0226f00a82c47a4c Mon Sep 17 00:00:00 2001 From: Andrew Scheller Date: Mon, 8 Mar 2021 09:33:08 +0000 Subject: [PATCH] Fixup incorrect doxygen for multicore_fifo_wready --- src/rp2_common/pico_multicore/include/pico/multicore.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/rp2_common/pico_multicore/include/pico/multicore.h b/src/rp2_common/pico_multicore/include/pico/multicore.h index 3d52654..112c395 100644 --- a/src/rp2_common/pico_multicore/include/pico/multicore.h +++ b/src/rp2_common/pico_multicore/include/pico/multicore.h @@ -84,10 +84,10 @@ static inline bool multicore_fifo_rvalid(void) { return !!(sio_hw->fifo_st & SIO_FIFO_ST_VLD_BITS); } -/*! \brief Check the FIFO to see if the write FIFO is full +/*! \brief Check the write FIFO to see if it is ready for more data * \ingroup multicore_fifo * - * @return true if the FIFO is full, false otherwise + * @return true if the FIFO has room for more data, false otherwise */ static inline bool multicore_fifo_wready(void) { return !!(sio_hw->fifo_st & SIO_FIFO_ST_RDY_BITS);