Fix network documentation coverage #72992
Merged
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
zephyrbot
added
area: CAN
area: Networking
area: Wi-Fi
zephyrbot
requested review from
alexanderwachter,
cfriedt,
fgrandel,
glarsennordic,
henrikbrixandersen,
jciupis,
krish2718,
maass-hamburg,
martinjaeger,
pdgendt,
rlubos,
ssharks,
str4t0m and
tbursztyka
pdgendt
reviewed
May 19, 2024
jukkar
force-pushed
the
fix/net-documentation-coverage
branch
2 times, most recently
from
f070d8d
to
fc7af9a
Compare
fgrandel
reviewed
May 19, 2024
jukkar
force-pushed
the
fix/net-documentation-coverage
branch
from
fc7af9a
to
b775d0f
Compare
|
Added missing doxygen comments. Also hide internal symbols from generated documentation. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
jukkar
force-pushed
the
fix/net-documentation-coverage
branch
from
b775d0f
to
563ca5e
Compare
zephyrbot
added
the
area: Networking Buffers
Fix the documentation in ptp_time.h to improve the documentation coverage. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
Fix doxygen documentation in sntp.h header file. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
Some of the internal macros can be hidden from generated documentation. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
No need to generate documentation for internal data. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
Fix the socket_offload.h header file documentation. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
No need to generate public documentation for internal data. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
Do not add internal symbols to generated documentation. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
No need to generate documentation for internal data. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
Add missing doxygen documentation to socketcan.h header file. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
This will improve documentation coverage. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
The @brief was in wrong place. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
The trickle.h was missing couple of doxygen comments. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
The virtual API was not properly documented. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
Opcodes were not documented. Also removed init function from public documentation as it is not needed there. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
Add missing doxygen comments and improve documentation coverage. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
Add missing doxygen comments for wifi_mgmt.h header file. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
No need to generate documentation for internal data in wifi_nm.h Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
The wifi_utils.h was missing couple of doxygen comments. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
The zperp.h header file was missing doxygen comments. Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
jukkar
force-pushed
the
fix/net-documentation-coverage
branch
from
306c8d5
to
2b5fb70
Compare
|
maass-hamburg
approved these changes
May 21, 2024
pdgendt
approved these changes
May 21, 2024
rlubos
approved these changes
May 21, 2024
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.
This should improve network documentation coverage percentage.
So I added missing doxygen comments when applicable or hide internal documentation which does not need to be documented.
There are lot of commits, but most of them are very small. Each header file changed is placed in its own commit for easier revert / fix if needed.