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

Update the names of some of the newly introduced API functions so they are more consistent with the names of pre-existing API functions.

Browse source
This commit is contained in:
Richard Barry 2011-08-07 10:22:20 +00:00
parent 405a2ca22c
commit 28629a7ea6
3 changed files with 22 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

17
Source/include/task.h
View file

@ -1007,16 +1007,17 @@ unsigned portBASE_TYPE uxTaskGetNumberOfTasks( void ) PRIVILEGED_FUNCTION;
/**
* task. h
* <PRE>signed char *pcTaskGetTaskName( xTaskHandle xTaskToQuery );</PRE>
* <PRE>signed char *pcTaskNameGet( xTaskHandle xTaskToQuery );</PRE>
*
* @return The text (human readable) name of the task referenced by the handle
* xTaskToQueury. A task can query its own name by either passing in its own
* handle, or by setting xTaskToQuery to NULL.
* handle, or by setting xTaskToQuery to NULL. INCLUDE_pcTaskNameGet must be
* set to 1 in FreeRTOSConfig.h for pcTaskNameGet() to be available.
*
* \page pcTaskGetTaskName pcTaskGetTaskName
* \page pcTaskNameGet pcTasknameGet
* \ingroup TaskUtils
*/
signed char *pcTaskGetTaskName( xTaskHandle xTaskToQuery );
signed char *pcTaskNameGet( xTaskHandle xTaskToQuery );
/**
* task. h
@ -1171,13 +1172,13 @@ constant. */
portBASE_TYPE xTaskCallApplicationTaskHook( xTaskHandle xTask, void *pvParameter ) PRIVILEGED_FUNCTION;
/**
* xTaskGetIdleTaskHandle() is only available if
* INCLUDE_xTaskGetIdleTaskHandle is set to 1 in FreeRTOSConfig.h.
* xTaskIdleTaskHandleGet() is only available if
* INCLUDE_xTaskIdleTaskHandleGet is set to 1 in FreeRTOSConfig.h.
*
* Simply returns the handle of the idle task. It is not valid to call
* xTaskGetIdleTaskHandle() before the scheduler has been started.
* xTaskIdleTaskHandleGet() before the scheduler has been started.
*/
xTaskHandle xTaskGetIdleTaskHandle( void );
xTaskHandle xTaskIdleTaskHandleGet( void );
/*-----------------------------------------------------------
* SCHEDULER INTERNALS AVAILABLE FOR PORTING PURPOSES