Cleanup doc comments#2
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR cleans up and modernizes documentation comments across the EventBus packages, aiming to make developer-facing guidance clearer and less redundant.
Changes:
- Updates
eventbus/README.mdwording and refreshes Git install URLs. - Rewrites/condenses XML doc comments in core EventBus types to improve clarity.
- Removes redundant file header comments and some separator-style comments.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| eventbus/README.md | Refines package/readme text and updates Git install URLs. |
| eventbus/com.wehlney.eventbus/Runtime/Core/SubscriptionBag.cs | Improves class summary documentation. |
| eventbus/com.wehlney.eventbus/Runtime/Core/Subscriber.cs | Removes redundant file header comment. |
| eventbus/com.wehlney.eventbus/Runtime/Core/Publisher.cs | Removes redundant file header comment; refines an inline guard comment. |
| eventbus/com.wehlney.eventbus/Runtime/Core/Events.cs | Refactors XML docs for marker interfaces and base event record. |
| eventbus/com.wehlney.eventbus/Runtime/Core/EventBus.cs | Removes section-separator comments. |
| eventbus/com.wehlney.eventbus.reflex/Runtime/Reflex/PurrNetPubSubBindings.cs | Removes redundant file header comment. |
| eventbus/com.wehlney.eventbus.reflex/Runtime/Reflex/PubSubBindings.cs | Refactors XML docs (summary/remarks/param/exception) for DI registration helpers. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+16
to
+18
| "com.wehlney.eventbus": "https://github.com/Wehlney/unity-packages.git?path=/eventbus/com.wehlney.eventbus#v0.1.0", | ||
| "com.wehlney.eventbus.purrnet": "https://github.com/Wehlney/unity-packages.git?path=/eventbus/com.wehlney.eventbus.purrnet#v0.1.0", | ||
| "com.wehlney.eventbus.reflex": "https://github.com/Wehlney/unity-packages.git?path=/eventbus/com.wehlney.eventbus.reflex#v0.1.0" |
Comment on lines
6
to
8
| /// <summary> | ||
| /// holds SubscriptionTokens central. | ||
| /// No IDisposable-Interfaces -> No Boxing. | ||
| /// Owns subscription tokens without storing them as IDisposable, avoiding boxing on dispose. | ||
| /// </summary> |
This file contains hidden or 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
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.