Fixup incorrect doxygen for multicore_fifo_wready

This commit is contained in:
Andrew Scheller 2021-03-08 09:33:08 +00:00 committed by Luke Wren
parent 3ad5e1570c
commit 26fd36f853

View File

@ -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);