diff --git a/include/message_buffer.h b/include/message_buffer.h index 9fb97ffd06b..cac6db3ba42 100644 --- a/include/message_buffer.h +++ b/include/message_buffer.h @@ -560,14 +560,14 @@ typedef StreamBufferHandle_t MessageBufferHandle_t; * * Example use: * @code{c} - * void vAFunction( MessageBuffer_t xMessageBuffer ) + * void vAFunction( MessageBufferHandle_t xMessageBuffer ) * { * uint8_t ucRxData[ 20 ]; * size_t xReceivedBytes; * const TickType_t xBlockTime = pdMS_TO_TICKS( 20 ); * * // Receive the next message from the message buffer. Wait in the Blocked - * // state (so not using any CPU processing time) for a maximum of 100ms for + * // state (so not using any CPU processing time) for a maximum of 20ms for * // a message to become available. * xReceivedBytes = xMessageBufferReceive( xMessageBuffer, * ( void * ) ucRxData, @@ -655,7 +655,7 @@ typedef StreamBufferHandle_t MessageBufferHandle_t; * Example use: * @code{c} * // A message buffer that has already been created. - * MessageBuffer_t xMessageBuffer; + * MessageBufferHandle_t xMessageBuffer; * * void vAnInterruptServiceRoutine( void ) * { diff --git a/include/stream_buffer.h b/include/stream_buffer.h index b0093fc8020..577420c4465 100644 --- a/include/stream_buffer.h +++ b/include/stream_buffer.h @@ -760,7 +760,7 @@ size_t xStreamBufferSendFromISR( StreamBufferHandle_t xStreamBuffer, * * Example use: * @code{c} - * void vAFunction( StreamBuffer_t xStreamBuffer ) + * void vAFunction( StreamBufferHandle_t xStreamBuffer ) * { * uint8_t ucRxData[ 20 ]; * size_t xReceivedBytes; @@ -768,7 +768,7 @@ size_t xStreamBufferSendFromISR( StreamBufferHandle_t xStreamBuffer, * * // Receive up to another sizeof( ucRxData ) bytes from the stream buffer. * // Wait in the Blocked state (so not using any CPU processing time) for a - * // maximum of 100ms for the full sizeof( ucRxData ) number of bytes to be + * // maximum of 20ms for the full sizeof( ucRxData ) number of bytes to be * // available. * xReceivedBytes = xStreamBufferReceive( xStreamBuffer, * ( void * ) ucRxData, @@ -840,7 +840,7 @@ size_t xStreamBufferReceive( StreamBufferHandle_t xStreamBuffer, * Example use: * @code{c} * // A stream buffer that has already been created. - * StreamBuffer_t xStreamBuffer; + * StreamBufferHandle_t xStreamBuffer; * * void vAnInterruptServiceRoutine( void ) * { @@ -1218,7 +1218,7 @@ UBaseType_t uxStreamBufferGetStreamBufferNotificationIndex( StreamBufferHandle_t * stream_buffer.h * * @code{c} - * void vStreamBufferSetStreamBufferNotificationIndex ( StreamBuffer_t xStreamBuffer, UBaseType_t uxNotificationIndex ); + * void vStreamBufferSetStreamBufferNotificationIndex ( StreamBufferHandle_t xStreamBuffer, UBaseType_t uxNotificationIndex ); * @endcode * * Set the task notification index used for the supplied stream buffer.