RTEMS | chain: Fix documentation mismatch in rtems_chain_is_node_off_chain (fixes #4812) (!870)

[Gedare Bloom (@gedare)]

Gedare Bloom started a new discussion on cpukit/include/rtems/chain.h: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/870#note_137106

 >    _Chain_Initialize_empty( the_chain );
 >  }
 >  
 > -/**
 > - * @brief Set off chain.
 > - *
 > - * This function sets the next and previous fields of the @a node to NULL
 > - * indicating the @a node is not part of a chain.
 > - *
 > - * @param[in] node the node set to off chain.
 > - */
 > + /** 
 > + * @brief Checks if the node is off chain. 
 > + * 
 > + * This function returns true if the @a node is considered off chain by the * internal Chain implementation. A node is regarded as off chain when its * "next" pointer is NULL. The implementation does not require the "previous" * pointer to be NULL for this check. * * @param[in] node The node to check. 

This is not the correct place for this documentation.

-- 
View it on GitLab: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/870#note_137106
You're receiving this email because of your account on gitlab.rtems.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20251210/b30fd8ed/attachment-0001.htm>