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

include/zephyr/net: Add 'brief' to group description #66266

Merged
merged 1 commit into from
Dec 7, 2023

Conversation

jukkar
Copy link
Member

@jukkar jukkar commented Dec 7, 2023

So it doesn't extend previous directive.

This is cherry-picked from #61994 as that PR might take some time to get merged and the change makes sense.
FYI @edersondisouza

So it doesn't extend previous directive.

Signed-off-by: Ederson de Souza <ederson.desouza@intel.com>
@zephyrbot zephyrbot added the Trivial Changes that can be reviewed by anyone, i.e. doc changes, minor build system tweaks, etc. label Dec 7, 2023
@zephyrbot zephyrbot requested review from krish2718 and rlubos December 7, 2023 10:13
@jukkar jukkar removed the request for review from rlubos December 7, 2023 10:13
@jukkar jukkar requested review from kartben, rlubos and krish2718 and removed request for krish2718 December 7, 2023 10:13
@kartben
Copy link
Collaborator

kartben commented Dec 7, 2023

@jukkar
Obviously not opposed to the change as it's sometimes nice to be explicit, but where is the problem showing? @brief is implicit in this instance, and AFAICT it's looking OK everywhere I looked, i.e. https://docs.zephyrproject.org/latest/connectivity/networking/api/wifi.html#api-reference and https://docs.zephyrproject.org/latest/doxygen/html/group__wifi__mgmt.html#details

Just pointing it out to make sure that this is not instead the symptom of an issue in #61994.

@jukkar
Copy link
Member Author

jukkar commented Dec 7, 2023

Just pointing it out to make sure that this is not instead the symptom of an issue in #61994.

Ok, could be a side effect of something else but anyway we have the @brief strings in other headers so it should make no harm to have it here too.

@fabiobaltieri fabiobaltieri merged commit 026908b into zephyrproject-rtos:main Dec 7, 2023
26 checks passed
@jukkar jukkar deleted the fix/wifi-header-doc branch December 8, 2023 11:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Networking area: Wi-Fi Wi-Fi Trivial Changes that can be reviewed by anyone, i.e. doc changes, minor build system tweaks, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants