Make the pcObjectGetName() API function naming consistent - so rename pcTaskGetTaskNa...

[freertos] / FreeRTOS / Source / include / task.h

diff --git a/FreeRTOS/Source/include/task.h b/FreeRTOS/Source/include/task.h
index 7af7a2e76af200572a5bf8c83d42428106236051..f546e1596f5be666043e21325cfd8dac0733222c 100644 (file)
--- a/FreeRTOS/Source/include/task.h
+++ b/FreeRTOS/Source/include/task.h
@@ -416,7 +416,7 @@ is used in assert() statements. */
  *\r
  * @return If neither pxStackBuffer or pxTaskBuffer are NULL, then the task will\r
  * be created and pdPASS is returned.  If either pxStackBuffer or pxTaskBuffer\r
- * are NULL then the task will not be created and \r
+ * are NULL then the task will not be created and\r
  * errCOULD_NOT_ALLOCATE_REQUIRED_MEMORY is returned.\r
  *\r
  * Example usage:\r
@@ -1302,17 +1302,16 @@ UBaseType_t uxTaskGetNumberOfTasks( void ) PRIVILEGED_FUNCTION;
 \r
 /**\r
  * task. h\r
- * <PRE>char *pcTaskGetTaskName( TaskHandle_t xTaskToQuery );</PRE>\r
+ * <PRE>char *pcTaskGetName( TaskHandle_t xTaskToQuery );</PRE>\r
  *\r
  * @return The text (human readable) name of the task referenced by the handle\r
  * xTaskToQuery.  A task can query its own name by either passing in its own\r
- * handle, or by setting xTaskToQuery to NULL.  INCLUDE_pcTaskGetTaskName must be\r
- * set to 1 in FreeRTOSConfig.h for pcTaskGetTaskName() to be available.\r
+ * handle, or by setting xTaskToQuery to NULL.\r
  *\r
- * \defgroup pcTaskGetTaskName pcTaskGetTaskName\r
+ * \defgroup pcTaskGetName pcTaskGetName\r
  * \ingroup TaskUtils\r
  */\r
-char *pcTaskGetTaskName( TaskHandle_t xTaskToQuery ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
+char *pcTaskGetName( TaskHandle_t xTaskToQuery ) PRIVILEGED_FUNCTION; /*lint !e971 Unqualified char types are allowed for strings and single characters only. */\r
 \r
 /**\r
  * task. h\r