Skip to content

Conversation

@SpectrumFRC3847
Copy link
Contributor

No description provided.

Co-authored-by: Project516 <138796702+Project516@users.noreply.github.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR improves Javadoc formatting across multiple Java files by adding proper parameter descriptions and return value documentation. The changes focus on replacing incomplete or missing Javadoc comments with descriptive documentation.

Key changes include:

  • Enhanced Javadoc parameter descriptions with meaningful explanations
  • Added proper return value documentation where previously missing
  • Fixed a string comparison issue using .equals() instead of ==
  • Updated container version in GitHub workflow

Reviewed Changes

Copilot reviewed 14 out of 15 changed files in this pull request and generated no comments.

Show a summary per file
File Description
LimelightHelpers.java Fixed string comparison and added comprehensive Javadoc descriptions for pose-related methods
Limelight.java Enhanced Javadoc with parameter descriptions and removed unused import
Mechanism.java Added detailed parameter and return descriptions for conversion and velocity methods
Gamepad.java Improved constructor documentation formatting and added return descriptions
SpectrumState.java Added parameter and return descriptions for state manipulation methods
Vision.java Added return descriptions for limelight selection methods
Swerve.java Enhanced zone checking method documentation with parameter descriptions
StateChampsOffsets.java Added parameter and return descriptions for converter method
Zones.java Fixed HTML entities and added parameter descriptions
TagProperties.java Enhanced constructor documentation with detailed parameter descriptions
FieldHelpers.java Added comprehensive parameter and return descriptions for utility methods
Trigger.java Fixed parameter names and added missing documentation
gradle.properties Enabled Gradle caching
main.yml Updated container version from 2024 to 2025

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@SpectrumFRC3847 SpectrumFRC3847 deleted the javadoc-formatting branch October 9, 2025 22:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants