Dev #4
Merged
Dev #4
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
conectado
approved these changes
Mar 30, 2023
Comment on lines
+702
to
+716
| /// Print detailed information about a network packet. | ||
| /// | ||
| /// This function takes an `IntermediateBuffer` containing a network packet and prints various | ||
| /// details about the packet, such as Ethernet, IPv4, IPv6, ICMPv4, ICMPv6, UDP, and TCP information. | ||
| /// | ||
| /// # Arguments | ||
| /// | ||
| /// * `packet` - A mutable reference to an `ndisapi::IntermediateBuffer` containing the network packet. | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ```no_run | ||
| /// let mut packet: ndisapi::IntermediateBuffer = ...; | ||
| /// print_packet_info(&mut packet); | ||
| /// ``` |
There was a problem hiding this comment.
Functions in example are not exposed therefore docs aren't generated.
So we shouldn't write examples here or comments with ///. We can just write:
// Print into stdout detailed information about a network packet
There was a problem hiding this comment.
Yes, you're right, the documentation won't be generated. However, I find convenient to have the function information highlighted in Visual Studio Code. See the screenshot below:
If I replace '///' to '//' it changes to
Comment on lines
+158
to
+173
|
|
||
| /// Print detailed information about a network packet. | ||
| /// | ||
| /// This function takes an `IntermediateBuffer` containing a network packet and prints various | ||
| /// details about the packet, such as Ethernet, IPv4, IPv6, ICMPv4, ICMPv6, UDP, and TCP information. | ||
| /// | ||
| /// # Arguments | ||
| /// | ||
| /// * `packet` - A mutable reference to an `ndisapi::IntermediateBuffer` containing the network packet. | ||
| /// | ||
| /// # Examples | ||
| /// | ||
| /// ```no_run | ||
| /// let mut packet: ndisapi::IntermediateBuffer = ...; | ||
| /// print_packet_info(&mut packet); | ||
| /// ``` |
There was a problem hiding this comment.
Same as above for comments in examples
| @@ -174,3 +118,85 @@ fn main() -> Result<()> { | |||
|
|
|||
| Ok(()) | |||
| } | |||
|
|
|||
Co-authored-by: Gabi <gabrielalejandro7@gmail.com>
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.
No description provided.