Improve JavaDoc in GitScmProviderRepository by replacing TODO placeholders #1352
Conversation
There was a problem hiding this comment.
Pull request overview
This PR improves JavaDoc documentation by replacing TODO placeholders with meaningful descriptions in GitScmProviderRepository and adding detailed deprecation documentation to AbstractChangeLogCommand.
Key changes:
- Replaced TODO in PROTOCOL_RSYNC constant with descriptive documentation
- Added comprehensive @param and @return descriptions for getUrl(RepositoryUrl) method
- Added detailed @deprecated JavaDoc for three legacy changelog command methods
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| GitScmProviderRepository.java | Enhanced JavaDoc for PROTOCOL_RSYNC constant and getUrl() method by replacing TODO placeholders with descriptive documentation |
| AbstractChangeLogCommand.java | Added comprehensive @deprecated JavaDoc to three legacy executeChangeLogCommand method overloads explaining their backward compatibility purpose |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| * use for Git operations | ||
| */ | ||
| private String getUrl(RepositoryUrl repoUrl) { | ||
|
|
There was a problem hiding this comment.
An unnecessary blank line has been added within the method body. This deviates from the surrounding code style where the method body starts immediately after the opening brace. The blank line should be removed to maintain consistency.
| * This value is used when parsing SCM URLs and represents a repository | ||
| * that is retrieved using the rsync protocol. Currently, rsync is | ||
| * recognized but not actively implemented by the Git SCM provider. |
There was a problem hiding this comment.
The documentation states "Currently, rsync is recognized but not actively implemented by the Git SCM provider," which is misleading. Looking at the code, PROTOCOL_RSYNC is actually parsed from URLs (line 321-322), included in urlSupportsUserInformation (line 246), and used to construct repository URLs. While there may not be special rsync-specific handling, the protocol is functionally supported like other protocols. The documentation should clarify what "not actively implemented" means, or if rsync is actually fully supported, the documentation should reflect that accurately.
| * This value is used when parsing SCM URLs and represents a repository | |
| * that is retrieved using the rsync protocol. Currently, rsync is | |
| * recognized but not actively implemented by the Git SCM provider. | |
| * This value is used when parsing SCM URLs and constructing repository | |
| * URLs that use the rsync protocol. The Git SCM provider does not apply | |
| * any rsync-specific behavior; rsync-based URLs are handled in the same | |
| * generic way as other supported protocols. |
|
Just checking in on this PR. It has been idle for a while and is still awaiting workflow approval and review. |
1 participant
Summary
Improves documentation clarity by replacing TODO placeholders in
GitScmProviderRepository JavaDoc with meaningful descriptions.
Changes
Rationale
Helps readability and maintainability.
No functional or behavioral changes.
Following this checklist to help us incorporate your
contribution quickly and easily:
Note that commits might be squashed by a maintainer on merge.
This may not always be possible but is a best-practice.
mvn verifyto make sure basic checks pass.A more thorough check will be performed on your pull request automatically.
mvn -Prun-its verify).If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.