Add SpotBugs Annotations #124
Merged
Conversation
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
- Add SpotBugs annotations dependency - Update ICalendarParser to use `@WillNotClose`
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds the @WillNotClose annotation to the parse method's reader parameter to document that the method does not close the provided Reader. Additionally, it removes an outdated parameter documentation reference and updates a noinspection comment.
- Added SpotBugs annotations dependency as
compileOnlyto provide resource management documentation - Annotated the
readerparameter with@WillNotCloseto clarify resource ownership - Cleaned up KDoc by removing outdated
@param tzRegistrydocumentation
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| lib/src/main/kotlin/at/bitfire/synctools/icalendar/ICalendarParser.kt | Added @WillNotClose annotation to parse() method's reader parameter and removed outdated parameter documentation |
| lib/build.gradle.kts | Added SpotBugs annotations as a compile-only dependency |
| gradle/libs.versions.toml | Added SpotBugs annotations library definition and updated noinspection comment |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.