Add examples to PacketPeerUDP class documentation #99015
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
Mickeon
reviewed
Nov 10, 2024
Mickeon
approved these changes
Nov 10, 2024
CabalCrow
force-pushed
the
PacketPeerUDP-docs-example
branch
from
42f1a47 to
ad772de
Compare
Add examples for sending packets and listening for packets. Fix documentation indentation. Change tabs to spaced for codeblocks. Fix typos Remove typing in documentation code Add a blank line to comply with style guidelines Fix blank line to contain tabs Remove tabs from empty code lines Commit suggested changes by Mickeon Use correct syntax for >
CabalCrow
force-pushed
the
PacketPeerUDP-docs-example
branch
from
6a82d54 to
5516088
Compare
|
Thanks! Congratulations on your first contribution! 🎉 |
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.
Currently to understand how to properly use PacketPeerUDP you need to read through both the methods of the class and the methods of PacketPeer. This is why I added examples for what I believe are the main things you would be using the class.
P.S.: The PacketPeerUDP.bind() method documentation needs updating, as it doesn't just affect the listening port, but also affects the port used to send packets (I showcase this in the example). This is not documented. However I'm not well versed in the actual code of this method, so I'm not sure how to precisely exaplain its exact function. This is why I haven't made changes to the bind method description.