len0rd/FreeRTOS-Kernel
1
0
Fork 0
mirror of https://github.com/FreeRTOS/FreeRTOS-Kernel.git synced 2026-10-10 08:02:57 -04:00
Code Issues Projects Releases Packages Wiki Activity

Fix duplicate Doxygen \defgroup ids in croutine.h and queue.h

Browse source 
Fix incorrect Doxygen \defgroup identifiers that reuse group ids
already defined by other API functions:

- croutine.h: \defgroup crSTART -> crEND for the crEND() macro doc
- queue.h: \defgroup uxQueueMessagesWaiting -> uxQueueSpacesAvailable
  for the uxQueueSpacesAvailable() function doc
- queue.h: \defgroup xQueueSendFromISR -> xQueueSendToBackFromISR
  for the xQueueSendToBackFromISR() macro doc
- queue.h: \defgroup xQueueSendFromISR -> xQueueGenericSendFromISR
  for the xQueueGenericSendFromISR() function doc

When building documentation with Doxygen, these duplicates cause
warnings like: group X: ignoring title Y that does not match old title Z

Signed-off-by: hanzhijian <hanzhijian@zepp.com>
This commit is contained in:
hanzhijian 2026-06-14 06:04:30 +08:00
parent 543558ba77
commit b318686d1a
2 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
include/croutine.h
View file

@ -243,7 +243,7 @@ void vCoRoutineSchedule( void );
* crEND(); * crEND();
* } * }
* @endcode * @endcode
* \defgroup crSTART crSTART * \defgroup crEND crEND
* \ingroup Tasks * \ingroup Tasks
*/ */

6
include/queue.h
View file

@ -945,7 +945,7 @@ UBaseType_t uxQueueMessagesWaiting( const QueueHandle_t xQueue ) PRIVILEGED_FUNC
* *
* @return The number of spaces available in the queue. * @return The number of spaces available in the queue.
* *
* \defgroup uxQueueMessagesWaiting uxQueueMessagesWaiting * \defgroup uxQueueSpacesAvailable uxQueueSpacesAvailable
* \ingroup QueueManagement * \ingroup QueueManagement
*/ */
UBaseType_t uxQueueSpacesAvailable( const QueueHandle_t xQueue ) PRIVILEGED_FUNCTION; UBaseType_t uxQueueSpacesAvailable( const QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;
@ -1111,7 +1111,7 @@ void vQueueDelete( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;
* } * }
* @endcode * @endcode
* *
* \defgroup xQueueSendFromISR xQueueSendFromISR * \defgroup xQueueSendToBackFromISR xQueueSendToBackFromISR
* \ingroup QueueManagement * \ingroup QueueManagement
*/ */
#define xQueueSendToBackFromISR( xQueue, pvItemToQueue, pxHigherPriorityTaskWoken ) \ #define xQueueSendToBackFromISR( xQueue, pvItemToQueue, pxHigherPriorityTaskWoken ) \
@ -1363,7 +1363,7 @@ void vQueueDelete( QueueHandle_t xQueue ) PRIVILEGED_FUNCTION;
* } * }
* @endcode * @endcode
* *
* \defgroup xQueueSendFromISR xQueueSendFromISR * \defgroup xQueueGenericSendFromISR xQueueGenericSendFromISR
* \ingroup QueueManagement * \ingroup QueueManagement
*/ */
BaseType_t xQueueGenericSendFromISR( QueueHandle_t xQueue, BaseType_t xQueueGenericSendFromISR( QueueHandle_t xQueue,