-
Notifications
You must be signed in to change notification settings - Fork 0
merge from branch 132 - 1 #81
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…code documentation
…ode documentation
…d code documentation
There was a problem hiding this 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 pull request adds comprehensive JavaDoc documentation to existing controller classes and related components. The changes focus on improving code documentation without modifying the core functionality of the REST API controllers.
- Adds class-level and method-level JavaDoc comments to all public methods and classes
- Includes parameter descriptions, return value documentation, and exception information
- Removes some trailing whitespace and commented-out code snippets
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
File | Description |
---|---|
CustomerController.java | Added comprehensive JavaDoc documentation for all endpoints and class fields |
CustomErrorController.java | Added JavaDoc documentation for exception handling methods with inline comments |
BeerOrderController.java | Added JavaDoc documentation for all CRUD operations and endpoint methods |
BeerController.java | Added JavaDoc documentation for all beer-related endpoints and removed commented code |
LogbookConfig.java | Added JavaDoc documentation for configuration class and bean method |
BootstrapData.java | Added JavaDoc documentation for bootstrap methods and removed commented code |
Comments suppressed due to low confidence (2)
src/main/java/com/example/springpracticerestmvc/controllers/CustomErrorController.java:53
- Variable name 'response_entity' uses snake_case which is inconsistent with Java naming conventions. It should be renamed to 'responseEntity' using camelCase.
ResponseEntity.BodyBuilder response_entity = ResponseEntity.badRequest();
src/main/java/com/example/springpracticerestmvc/controllers/CustomErrorController.java:62
- Variable name 'error_map' uses snake_case which is inconsistent with Java naming conventions. It should be renamed to 'errorMap' using camelCase.
Map<String, String> error_map = new HashMap<>();
src/main/java/com/example/springpracticerestmvc/bootstrap/BootstrapData.java
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
all ok
No description provided.