xCoRoutineCreate() documentation

Posted by Cesar Verdes on April 26, 2010
I think that there is a silly small error at the
“xCoRoutineCreate()”
function documentation in the
“croutine.h”
file.

The example defines and declares a
“xTimeToDelay[]”
vector as:

crDELAY( xHandle, uxFlashRates[ uxIndex ] );


This vector is never used, but the
“uxFlashRates ”
does.

I think that in this documentation example, the previous line should be replaced by:

static const portTickType uxFlashRates[ 2 ] = { 200, 400 };


Best Regards

César

RE: xCoRoutineCreate() documentation

Posted by Cesar Verdes on April 26, 2010
Sorry, I made a bad use of the Quote feature in my previous post. This is what I have tried to post.

I think that there is a silly small error at the xCoRoutineCreate() function documentation in the croutine.h file.
The example defines and declares a xTimeToDelay[] vector as:
static const portTickType xTimeToDelay[ 2 ] = { 200, 400 };

This vector is never used, but the uxFlashRates[] does.
I think that in this documentation example, the previous line should be replaced by:
static const portTickType uxFlashRates[ 2 ] = { 200, 400 };


Sorry for my wrong writen first post. :-(

César

RE: xCoRoutineCreate() documentation

Posted by Richard on May 1, 2010
Thanks for taking the time to point this out. I have corrected the web page, although you may need to clear your web cache to see that changes. I have also corrected the comments in the croutine.h header file. The corrected header file is already in SVN so will definitely be in the next release too.

Regards.