Enable typedef to make docs able to link *_t structs. #185
Conversation
This file contains 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
chinglee-iot
approved these changes
Dec 10, 2024
sirnish
approved these changes
Dec 10, 2024
ActoryOu
added a commit
to ActoryOu/FreeRTOS-Cellular-Interface
that referenced
this pull request
Dec 10, 2024
ActoryOu
added a commit
to ActoryOu/FreeRTOS-Cellular-Interface
that referenced
this pull request
Dec 11, 2024
2 tasks
ActoryOu
added a commit
that referenced
this pull request
Dec 11, 2024
* Enable typedef to make docs able to link *_t structs. (#185) * Replace Synopsys link with blackduck one to solve link error. (#180) * Fix freertos.org link in the source and doxygen files (#177) --------- Co-authored-by: chinglee-iot <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Enable typedef to make docs able to link *_t structs.
Description
As #184 mentioned, there are some missing handles in the doxygen docs. This PR not only adds handles back, but also enable typedef option in doxygen config to link *_t struct correctly for better user experience.
BEFORE this change: there is no link to the function parameters.
AFTER this change: and Handles are also fixed
Test Steps
Use
doxygento generate the docs locally.Checklist:
Related Issue
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.