len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2025-04-19 21:11:57 -04:00
Code Issues Packages Projects Releases Wiki Activity

Correct some documentation.

Browse source
This commit is contained in:
Richard Barry 2007-12-18 20:07:21 +00:00
parent fb799b7647
commit 2ac722926e
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
Source/include/semphr.h
View file

@ -328,7 +328,7 @@ typedef xQueueHandle xSemaphoreHandle;
/** /**
* semphr. h * semphr. h
* <pre>xSemaphoreCreateMutex( xSemaphoreHandle xSemaphore )</pre> * <pre>xSemaphoreHandle xSemaphoreCreateMutex( void )</pre>
* *
* <i>Macro</i> that implements a mutex semaphore by using the existing queue * <i>Macro</i> that implements a mutex semaphore by using the existing queue
* mechanism. * mechanism.
@ -344,7 +344,7 @@ typedef xQueueHandle xSemaphoreHandle;
* semaphore and another always 'takes' the semaphore) and from within interrupt * semaphore and another always 'takes' the semaphore) and from within interrupt
* service routines. * service routines.
* *
* @param xSemaphore Handle to the created mutex semaphore. Should be of type * @return xSemaphore Handle to the created mutex semaphore. Should be of type
* xSemaphoreHandle. * xSemaphoreHandle.
* *
* Example usage: * Example usage:
@ -353,9 +353,9 @@ typedef xQueueHandle xSemaphoreHandle;
void vATask( void * pvParameters ) void vATask( void * pvParameters )
{ {
// Semaphore cannot be used before a call to vSemaphoreCreateBinary (). // Semaphore cannot be used before a call to xSemaphoreCreateMutex().
// This is a macro so pass the variable in directly. // This is a macro so pass the variable in directly.
vSemaphoreCreateMutex( xSemaphore ); xSemaphore = xSemaphoreCreateMutex();
if( xSemaphore != NULL ) if( xSemaphore != NULL )
{ {