Fix duplicate Doxygen \defgroup ids in croutine.h and queue.h#1428
Open
Zepp-Hanzj wants to merge 1 commit into
Open
Fix duplicate Doxygen \defgroup ids in croutine.h and queue.h#1428Zepp-Hanzj wants to merge 1 commit into
Zepp-Hanzj wants to merge 1 commit into
Conversation
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 file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fix incorrect Doxygen
\defgroupidentifiers incroutine.handqueue.hthat reuse group ids already defined by other API functions.When building documentation with Doxygen, these duplicates cause warnings like:
This is the same type of issue fixed in PR #1426 for
uxTaskBasePriorityGet.Changes
croutine.hcrSTARTcrENDcrEND()macroqueue.huxQueueMessagesWaitinguxQueueSpacesAvailableuxQueueSpacesAvailable()queue.hxQueueSendFromISRxQueueSendToBackFromISRxQueueSendToBackFromISR()queue.hxQueueSendFromISRxQueueGenericSendFromISRxQueueGenericSendFromISR()Test Steps
grep -n 'defgroup' include/croutine.h include/queue.hthat no duplicate group ids remain for the fixed entries.Checklist