net: wifi: Add API docs #59859
Merged
net: wifi: Add API docs #59859
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
krish2718
force-pushed
the
add_wifi_api_doc
branch
from
54c03de
to
c72ff04
Compare
krish2718
force-pushed
the
add_wifi_api_doc
branch
from
c72ff04
to
eb2d383
Compare
krish2718
commented
Jul 12, 2023
krish2718
force-pushed
the
add_wifi_api_doc
branch
from
eb2d383
to
6cd8515
Compare
rlubos
reviewed
Jul 12, 2023
rlubos
reviewed
Jul 13, 2023
Support for legacy types has been added primarily to identify in scan results. Signed-off-by: Chaitanya Tata <[email protected]>
Fix doxygen formatting and add comments. Signed-off-by: Chaitanya Tata <[email protected]>
Add Wi-Fi management docs and APIs. Signed-off-by: Chaitanya Tata <[email protected]>
krish2718
force-pushed
the
add_wifi_api_doc
branch
from
6cd8515
to
5dbc870
Compare
rlubos
approved these changes
Jul 13, 2023
carlescufi
approved these changes
Jul 14, 2023
kartben
reviewed
Jul 14, 2023
There was a problem hiding this comment.
I realize this has been merged already, but somehow I missed the chance to review in time. Any chance you could address in a follow up PR? @krish2718
Comment on lines
+346
to
349
| /* TWT setup operation */ | ||
| WIFI_TWT_SETUP = 0, | ||
| /* TWT teardown operation */ | ||
| WIFI_TWT_TEARDOWN, |
There was a problem hiding this comment.
Missing javadoc style comment
Comment on lines
+359
to
364
| /* TWT individual negotiation */ | ||
| WIFI_TWT_INDIVIDUAL = 0, | ||
| /* TWT broadcast negotiation */ | ||
| WIFI_TWT_BROADCAST, | ||
| /* TWT wake TBTT negotiation */ | ||
| WIFI_TWT_WAKE_TBTT |
There was a problem hiding this comment.
Missing javadoc style comment
| enum wifi_twt_setup_cmd { | ||
| /* TWT Requests */ | ||
| /** TWT Requests */ |
There was a problem hiding this comment.
Use
/**
* @name TWT requests
* @{
To actually create a proper group
| WIFI_TWT_SETUP_CMD_DEMAND, | ||
| /* TWT Responses */ | ||
| /** TWT Responses */ |
Comment on lines
+376
to
+380
| /* TWT setup request */ | ||
| WIFI_TWT_SETUP_CMD_REQUEST = 0, | ||
| /* TWT setup suggest (parameters can be changed by AP) */ | ||
| WIFI_TWT_SETUP_CMD_SUGGEST, | ||
| /* TWT setup demand (parameters can not be changed by AP) */ |
There was a problem hiding this comment.
Missing javadoc style comments
Comment on lines
+383
to
392
| /* TWT setup grouping (grouping of TWT flows) */ | ||
| WIFI_TWT_SETUP_CMD_GROUPING, | ||
| /* TWT setup accept (parameters accepted by AP) */ | ||
| WIFI_TWT_SETUP_CMD_ACCEPT, | ||
| /* TWT setup alternate (alternate parameters suggested by AP) */ | ||
| WIFI_TWT_SETUP_CMD_ALTERNATE, | ||
| /* TWT setup dictate (parameters dictated by AP) */ | ||
| WIFI_TWT_SETUP_CMD_DICTATE, | ||
| /* TWT setup reject (parameters rejected by AP) */ | ||
| WIFI_TWT_SETUP_CMD_REJECT, |
There was a problem hiding this comment.
Missing javadoc style comment
|
Raised: #60406 |
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.
Add a basic API docs, this can be extended to add detailed sections and details in future PRs.
Based on #59249 as that has few structure changes.