Correct some documentation.

git-svn-id: https://svn.code.sf.net/p/freertos/code/trunk@128 1d2547de-c912-0410-9cb9-b8ca96c0e9e2

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