Skip to content

Commit 9440795

Browse files
committed
Improve comments
1 parent 7c2c7a8 commit 9440795

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

source/include/FreeRTOSIPConfigDefaults.h

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,7 @@
308308
* Type: TickType_t
309309
* Unit: milliseconds
310310
* Minimum: 0
311-
* Maximum: portMAX_DELAY * portTICK_PERIOD_MS
311+
* Maximum: ( portMAX_DELAY / configTICK_RATE_HZ ) * 1000
312312
*
313313
* Sets the timeout to wait for a response to a router
314314
* solicitation message.
@@ -357,7 +357,7 @@ STATIC_ASSERT( pdMS_TO_TICKS( ipconfigRA_SEARCH_TIME_OUT_MSEC ) <= portMAX_DELAY
357357
* Type: TickType_t
358358
* Unit: milliseconds
359359
* Minimum: 0
360-
* Maximum: portMAX_DELAY * portTICK_PERIOD_MS
360+
* Maximum: ( portMAX_DELAY / configTICK_RATE_HZ ) * 1000
361361
*
362362
* Sets the timeout to wait for a response to a neighbour solicitation message.
363363
*/
@@ -1726,8 +1726,7 @@ STATIC_ASSERT( ipconfigTCP_KEEP_ALIVE_INTERVAL <= ( portMAX_DELAY / configTICK_R
17261726
* network buffers are themselves blocked waiting for a network buffer.
17271727
*
17281728
* ipconfigUDP_MAX_SEND_BLOCK_TIME_TICKS is specified in RTOS ticks. A time in
1729-
* milliseconds can be converted to a time in ticks by dividing the time in
1730-
* milliseconds by portTICK_PERIOD_MS.
1729+
* milliseconds can be converted to a time in ticks using pdMS_TO_TICKS().
17311730
*/
17321731

17331732
#ifndef ipconfigUDP_MAX_SEND_BLOCK_TIME_TICKS

0 commit comments

Comments
 (0)