Revise API docs #330
Merged
Revise API docs #330
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
SergioGasquez
approved these changes
Nov 2, 2023
bugadani
reviewed
Nov 2, 2023
esp-wifi/src/wifi_interface.rs
Outdated
| @@ -14,6 +16,7 @@ use crate::wifi::{get_ap_mac, get_sta_mac, WifiDevice, WifiMode}; | |||
|
|
|||
| use core::borrow::BorrowMut; | |||
|
|
|||
| /// A TCP stack | |||
There was a problem hiding this comment.
This is not just a TCP stack, I think?
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.
In preparation of #154 this adds some API docs (not the most useful ones but we can improve those in future), hides some types (RxToken/TxToken) and changes other functions and types to
pub(crate).Probably the visibility could be reduced even more but it's a first step without changing too much