Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: doxygen: some minor fixes #75936

Merged
merged 10 commits into from
Jul 18, 2024
Merged

Conversation

gmarull
Copy link
Member

@gmarull gmarull commented Jul 16, 2024

Some minor doxygen fixes. Note that we probably need to rethink grouping, there are some areas that do not have a suitable candidate right now. For now, let's remove them from the top level at least.

Some groups were being added to a non-existing group: c_std_lib

Signed-off-by: Gerard Marull-Paretas <[email protected]>
The TEE driver interface was put under a non-existing group: security.

Signed-off-by: Gerard Marull-Paretas <[email protected]>
The API was placed under a non-existing group: coresight_apis. Place it
under os_services, as other debug/ APIs.

Signed-off-by: Gerard Marull-Paretas <[email protected]>
Instead of showing up as a top-level Doxygen group.

Signed-off-by: Gerard Marull-Paretas <[email protected]>
Instead of being a top-level group.

Signed-off-by: Gerard Marull-Paretas <[email protected]>
Instead of being a top-level group.

Signed-off-by: Gerard Marull-Paretas <[email protected]>
Instead of being a top-level group.

Signed-off-by: Gerard Marull-Paretas <[email protected]>
kartben
kartben previously approved these changes Jul 16, 2024
Copy link
Collaborator

@kartben kartben left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @gmarull

`@code` needs file extension
`@endcode` doesn't take any arguments

Signed-off-by: Gerard Marull-Paretas <[email protected]>
sys/arch_interface.h does no longer exist.

Signed-off-by: Gerard Marull-Paretas <[email protected]>
@nashif nashif assigned kartben and unassigned stephanosio Jul 16, 2024
nashif
nashif previously approved these changes Jul 16, 2024
Otherwise some recent Doxygen versions (1.11.0) generate a warning.

Signed-off-by: Gerard Marull-Paretas <[email protected]>
@gmarull gmarull requested a review from nashif July 16, 2024 13:03
gmarull added a commit to teslabs/zephyr that referenced this pull request Jul 16, 2024
zephyrproject-rtos#75936

Signed-off-by: Gerard Marull-Paretas <[email protected]>
@nashif nashif merged commit 5bf395b into zephyrproject-rtos:main Jul 18, 2024
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants