Fix comment in BackoffAlgorithm_GetNextBackoff (#27)

aggarw13 · web-flow · commit 1e5dd14f266b · 2021-06-03T13:03:35.000-07:00
Fix invalid comment about meaning of **BACKOFF_ALGORITHM_RETRY_FOREVER** constant in `BackoffAlgorithm_GetNextBackoff`API. The issue was pointed in #26.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,8 @@
 # Changelog for backoffAlgorithm Library
 
+## Changes after v1.0.1
+- [#27](https://github.com/FreeRTOS/backoffAlgorithm/pull/26) Fix incorrect comment about use of BACKOFF_ALGORITHM_RETRY_FOREVER constant in BackoffAlgorithm_GetNextBackoff API.
+
 ## v1.0.1 (February 2020)
 
 ### Changes
diff --git a/lexicon.txt b/lexicon.txt
@@ -31,6 +31,7 @@ longjmp
 mainpage
 maxattempts
 maxbackoff
+maxretryattempts
 min
 misra
 mockrng
@@ -55,4 +56,4 @@ td
 toolchain
 tr
 trng
-utils
+utils
diff --git a/source/backoff_algorithm.c b/source/backoff_algorithm.c
@@ -44,7 +44,7 @@ BackoffAlgorithmStatus_t BackoffAlgorithm_GetNextBackoff( BackoffAlgorithmContex
     assert( pRetryContext != NULL );
     assert( pNextBackOff != NULL );
 
-    /* If BACKOFF_ALGORITHM_RETRY_FOREVER is set to 0, try forever. */
+    /* If maxRetryAttempts state of the context is set to 0, retry forever. */
     if( ( pRetryContext->attemptsDone < pRetryContext->maxRetryAttempts ) ||
         ( pRetryContext->maxRetryAttempts == BACKOFF_ALGORITHM_RETRY_FOREVER ) )
     {

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@ BackoffAlgorithmStatus_t BackoffAlgorithm_GetNextBackoff( BackoffAlgorithmContex`
`44`	`44`	`assert( pRetryContext != NULL );`
`45`	`45`	`assert( pNextBackOff != NULL );`
`46`	`46`
`47`		`- /* If BACKOFF_ALGORITHM_RETRY_FOREVER is set to 0, try forever. */`
	`47`	`+ /* If maxRetryAttempts state of the context is set to 0, retry forever. */`
`48`	`48`	`if( ( pRetryContext->attemptsDone < pRetryContext->maxRetryAttempts ) \|\|`
`49`	`49`	`( pRetryContext->maxRetryAttempts == BACKOFF_ALGORITHM_RETRY_FOREVER ) )`
`50`	`50`	`{`