From b1ffe6cd86fd4112a620e99d42cecc6cb7f93dd8 Mon Sep 17 00:00:00 2001 From: richardbarry Date: Tue, 18 Dec 2007 20:07:21 +0000 Subject: [PATCH] Correct some documentation. git-svn-id: https://svn.code.sf.net/p/freertos/code/trunk@128 1d2547de-c912-0410-9cb9-b8ca96c0e9e2 --- Source/include/semphr.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Source/include/semphr.h b/Source/include/semphr.h index c14af05b5..029333130 100644 --- a/Source/include/semphr.h +++ b/Source/include/semphr.h @@ -328,7 +328,7 @@ typedef xQueueHandle xSemaphoreHandle; /** * semphr. h - *
xSemaphoreCreateMutex( xSemaphoreHandle xSemaphore )
+ *
xSemaphoreHandle xSemaphoreCreateMutex( void )
* * Macro that implements a mutex semaphore by using the existing queue * mechanism. @@ -344,7 +344,7 @@ typedef xQueueHandle xSemaphoreHandle; * semaphore and another always 'takes' the semaphore) and from within interrupt * 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. * * Example usage: @@ -353,9 +353,9 @@ typedef xQueueHandle xSemaphoreHandle; 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. - vSemaphoreCreateMutex( xSemaphore ); + xSemaphore = xSemaphoreCreateMutex(); if( xSemaphore != NULL ) { -- 2.39.5