@note not showing up in parsed source code

/**

This method can be used to query the link status of multiple interfaces.
@note
Not for use with KR or FC auto-negotiation. Use their respective AN-done
methods instead.
@note
check_time should be long enough to gain confidence the link is stable. For
most applications this is ~500ms. This value needs to be longer than 50ms
(approximate time it takes to lock).
@param interfaces [I] - A struct containing the interfaces to query
@param length [I] - The length of the interface struct (num of interfaces)
@param check_time [I] - The minimum duration in ms to check the link interrupt status, usually 500ms
@param links_ready [O] - TRUE for each link that is locked and ready, FALSE otherwise. *
@return CS_OK on success, CS_ERROR on failure. Does not represent lock state,
link_ready can be false while status can return CS_OK.
@example *
cs4224_interface_t interfaces[8] = {0};
cs_boolean links_ready[8] = {0}; *
for(i = 0; i < 8; i++)
{
interfaces[i].slice = i | upper_bits;
interfaces[i].mseq_id = CS4224_DPLX_LINE_MSEQ;
} *
// Query the status of all 8 line side receivers
cs4224_query_links_status(interfaces, 8, 1000, &links_ready[0]); */ cs_status cs4224_query_links_status( cs4224_interface_t interfaces[], cs_uint16 length, cs_uint32 check_time, cs_boolean links_ready[]) {

bradfordelliott / shorte