doc: nrf: add nrf_security APIs to the Doxygen input #20612
Conversation
github-actions
bot
added
doc-required
|
After documentation is built, you will find the preview for this PR here. |
CI InformationTo view the history of this post, clich the 'edited' button above Inputs:Sources:more detailsGithub labels
List of changed files detected by CI (0)Outputs:ToolchainVersion: Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped;
|
Headers had numerous Doxygen issues, this patch fixes all of them so that Doxygen build is clean from warnings/errors. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
So that they are processed and rendered by Doxygen. Note that grouping is still needed so that headers appear nicely in the "Topics" page. This is a task left to the maintainers of such code. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
gmarull
force-pushed
the
nrf-security-doxygen
branch
from
040cdba to
4d94f99
Compare
|
|
You can find the documentation preview for this PR here. |
There was a problem hiding this comment.
The original task NCSDK-30040 is requesting the inclusion of files under ncs/modules/crypto/oberon-psa-crypto/include/psa/, while this PR is including subsys/nrf_security/include (as per a follow-up request in a comment to NCSDK-30040).
Is it possible to satisfy the original requirement of including files from ncs/modules/crypto/oberon-psa-crypto/include/psa/, which are above the sdk-nrf dir?
If those headers contain valid Doxygen, maybe. You can easily try that based on this PR, I do not know which structure you need/want. |
Unfortunately, they have the same issues as you are fixing in this PR. Lots of I think the best would be to have this PR merged, and then I can continue to experiment separately with the structure. |
| * \retval #PSA_ERROR_COMMUNICATION_FAILURE | ||
| * \retval PSA_ERROR_CORRUPTION_DETECTED | ||
| * \retval #PSA_ERROR_STORAGE_FAILURE | ||
| * \retval PSA_ERROR_DATA_INVALID |
There was a problem hiding this comment.
Why do certain defines now start with # and others not?
...so that they are processed and rendered by Doxygen. Note that grouping
is still needed so that headers appear nicely in the "Topics" page.
This is a task left to the maintainers of such code.