Add doxygen components #142
Open
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
Harry-Ramsey
force-pushed
the
enable-doxygen
branch
3 times, most recently
from
cbfa3c0 to
59d1154
Compare
Harry-Ramsey
force-pushed
the
enable-doxygen
branch
from
59d1154 to
efb6dad
Compare
3 tasks
Harry-Ramsey
force-pushed
the
enable-doxygen
branch
2 times, most recently
from
4096adc to
eafc659
Compare
Harry-Ramsey
force-pushed
the
enable-doxygen
branch
2 times, most recently
from
bf1a9c5 to
177efd5
Compare
Harry-Ramsey
force-pushed
the
enable-doxygen
branch
from
177efd5 to
1818146
Compare
ronald-cron-arm
requested changes
Feb 4, 2025
This commit adds the components check_doxy_blocks and check_doxygen_warnings to TF-PSA-Crypto. Signed-off-by: Harry Ramsey <harry.ramsey@arm.com>
Harry-Ramsey
force-pushed
the
enable-doxygen
branch
5 times, most recently
from
e93d1db to
2eb5924
Compare
ronald-cron-arm
requested changes
Feb 6, 2025
There was a problem hiding this comment.
In doxygen/tfpsacrypto.doxyfile.in we need to change the entries INPUT, EXCLUDE and INCLUDE_PATH, aligning them with what we currently have in doxygen/mbedtls.doxyfile in Mbed TLS (we cannot ignore the legacy headers yet):
INPUT = ../include input ../drivers/builtin/include
EXCLUDE = ../include/psa/crypto_se_driver.h ../drivers/builtin/include/mbedtls/build_info.h
INCLUDE_PATH = ../include ../drivers/builtin/include
| @@ -133,6 +133,15 @@ def full_adapter(name, value, active): | |||
| return active | |||
| return include_in_full(name) | |||
|
|
|||
| def realfull_adapter(_name, _value, _active): | |||
There was a problem hiding this comment.
You need to add something in custom_parser_options in class TFPSACryptoConfigTool as well I think.
This commit adds a new adapter, realfull which is ued to activate all symbols. This is required for the doxygen test suite. Signed-off-by: Harry Ramsey <harry.ramsey@arm.com>
This commit updates the doxyfile to contain the relevant paths for the doxygen generation. Signed-off-by: Harry Ramsey <harry.ramsey@arm.com>
Harry-Ramsey
force-pushed
the
enable-doxygen
branch
from
2eb5924 to
ecb1413
Compare
ronald-cron-arm
force-pushed
the
enable-doxygen
branch
from
ecb1413 to
e21d135
Compare
|
I've updated the framework pointer that was not correct to get a new run of CI. |
This commit updates the framework to enable doxygen checks. Signed-off-by: Harry Ramsey <harry.ramsey@arm.com>
ronald-cron-arm
force-pushed
the
enable-doxygen
branch
from
e21d135 to
fc24cff
Compare
# for free
to join this conversation on GitHub.
Already have an account?
# 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.
Description
This commit enables doxygen components (specifically checks and warnings) for TF-PSA-Crypto. Closes #49.
PR checklist
Please remove the segment/s on either side of the | symbol as appropriate, and add any relevant link/s to the end of the line.
If the provided content is part of the present PR remove the # symbol.
Notes for the submitter
Please refer to the contributing guidelines, especially the
checklist for PR contributors.
Help make review efficient: