Replace TBD XML doc placeholders in UDP IO files#8089
Replace TBD XML doc placeholders in UDP IO files#8089MattKotsenas wants to merge 5 commits intoakkadotnet:devfrom
Conversation
Document all TBD XML doc blocks in the UDP-related IO files: UdpConnection, UdpListener, UdpSender, UdpConnectedManager, UdpManager, and UdpSettings. Doc-only change - no behavioral modifications. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Aaronontheweb
left a comment
There was a problem hiding this comment.
Looks good minus a few guidelines about not XML-DOCing overridden base class methods
| } | ||
|
|
||
| /// <summary> | ||
| /// TBD |
There was a problem hiding this comment.
Probably don't need any XML-DOCs at all for this - the natural inheritdoc from the base class should be sufficient.
src/core/Akka/IO/UdpSender.cs
Outdated
| /// </summary> | ||
| /// <param name="message">TBD</param> | ||
| /// <returns>TBD</returns> | ||
| /// <param name="message">The incoming message.</param> |
There was a problem hiding this comment.
Same as my comment on PostStop
|
My bad, will fix! |
All good, it's tricky - if you're using LLMs to do this you'll want to add something to the prompt like this:
|
|
Do you want a delete, or do you want an explicit ? |
|
I'd delete the XML-DOC comment - correct me if I'm wrong, but the child classes / implementations will inherit the base types comments in intellisense, right? |
|
I just double checked and yes, if you have nothing, Intellisense does automatically pick up the base type's xmldoc. Convention on my team is always to use |
Remove xmldocs in derived types where the base type already has good xmldocs.
that's a good point, maybe it's better that we do that then as a signal to other contributors that "this is covered already" |
|
@Aaronontheweb, updated (with explicit inheritdoc). Ready for another review. Double checking the other open PRs under my name now. |
Partial fix for #3435, contributes to #647.
Changes
Document all TBD XML doc blocks in the UDP-related IO files:
UdpConnection, UdpListener, UdpSender, UdpConnectedManager, UdpManager, and UdpSettings.
Doc-only change - no behavioral modifications.
Checklist