epagris/FreeRTOS-Kernel
1
0
Fork 1
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2026-06-19 17:43:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix duplicate Doxygen \defgroup id for uxTaskBasePriorityGet (#1426)

Browse Source 
uxTaskBasePriorityGet reused the \defgroup id 'uxTaskPriorityGet'
already defined by uxTaskPriorityGet, only with a different title.
Doxygen reported:

  task.h: warning: group uxTaskPriorityGet: ignoring title
  "uxTaskBasePriorityGet" that does not match old title
  "uxTaskPriorityGet"

Give uxTaskBasePriorityGet its own group id so both functions are
documented correctly.
This commit is contained in:
Archit Gupta 2026-06-15 17:34:12 +00:00 committed by GitHub
parent 543558ba77
commit fc25364931
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/task.h
View File

@ -1050,7 +1050,7 @@ UBaseType_t uxTaskPriorityGetFromISR( const TaskHandle_t xTask ) PRIVILEGED_FUNC
* *
* @return The base priority of xTask. * @return The base priority of xTask.
* *
* \defgroup uxTaskPriorityGet uxTaskBasePriorityGet * \defgroup uxTaskBasePriorityGet uxTaskBasePriorityGet
* \ingroup TaskCtrl * \ingroup TaskCtrl
*/ */
UBaseType_t uxTaskBasePriorityGet( const TaskHandle_t xTask ) PRIVILEGED_FUNCTION; UBaseType_t uxTaskBasePriorityGet( const TaskHandle_t xTask ) PRIVILEGED_FUNCTION;