Menu

#165 API Documentation for xQueueIsQueueEmptyFromISR() and xQueueIsQueueFullFromISR() is puzzling

v1.0 (example)
closed-fixed
nobody
None
5
2020-02-21
2018-04-16
No

The documentation states for xQueueIsQueueEmptyFromISR():

Returns:
pdFALSE if the queue is not empty, or any other value if the queue is empty.

Looking at the code I think this could be changed to:

Returns:
pdTRUE if the queue is empty, or pdFALSE if the queue is empty.

I think this is more aligned to that what someone would expect.

Similar for xQueueIsQueueFullFromISR():

Returns:
pdTRUE if the queue is full, or pdFALSE if the queue is not full.

Discussion

  • Richard Barry

    Richard Barry - 2020-02-21
    • status: open --> closed-fixed
     
  • Richard Barry

    Richard Barry - 2020-02-21

    Fixed, although at the time of writing the updated documentation has not been deployed to the website.

     

Log in to post a comment.

MongoDB Logo MongoDB