Skip to content
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

Added JavaDoc building in Actions. #6018

Merged
merged 8 commits into from
Sep 21, 2024

Conversation

rjhancock
Copy link
Collaborator

Added CheckStyle and configured for Google Format Guide Added .editorconfig and set defaults based upon Style Guide and Google Style Guide

Added CheckStyle and configured for Google Format Guide
Added .editorconfig and set defaults based upon Style Guide and Google Style Guide
Copy link

codecov bot commented Sep 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 29.09%. Comparing base (33e67a8) to head (036eda5).
Report is 62 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff              @@
##             master    #6018      +/-   ##
============================================
- Coverage     29.10%   29.09%   -0.01%     
- Complexity    13960    13972      +12     
============================================
  Files          2576     2580       +4     
  Lines        267045   267172     +127     
  Branches      47698    47710      +12     
============================================
+ Hits          77722    77744      +22     
- Misses       185422   185530     +108     
+ Partials       3901     3898       -3     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@SJuliez
Copy link
Member

SJuliez commented Sep 20, 2024

May I strongly suggest to increase the line columns to 120 (if not more), the reasons being

  • google uses 2 spaces indentation, we use 4, this adds 4 or more spaces to practically every line
  • we want descriptive method names, class names and variable names. Those are longer and breaking lines down because of this is counter-productive.
  • we live in 1440p or 4K times, at least for me there seems ample room for lines despite using big fonts and having some other windows/toolbars on the screen

@rjhancock
Copy link
Collaborator Author

This is the input I'm wanting. I based this off of the Google version and know we have a few things different.

Added config for XML, MTF, and BLK as a precaution
@rjhancock
Copy link
Collaborator Author

Adjusted to 140 characters, added additional filters for XML, MTF, and BLK for extra space, trailing line, line endings, etc.

Copy link
Member

@SJuliez SJuliez left a comment

Choose a reason for hiding this comment

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

I'm not entirely sure what this will all mean but it seems ok.

@SJuliez SJuliez merged commit 4816d40 into MegaMek:master Sep 21, 2024
6 checks passed
@rjhancock rjhancock deleted the javadoc-generated-in-actions branch September 21, 2024 10:22
@rjhancock
Copy link
Collaborator Author

The changes on Java files will bring them more in line with the MM Style Guide.

The changes on the others is just for prettifying them so they are easier to work with (trailing white space, 4 spaces between tags in XML, line endings are all LF, etc).

The encoding SHOULD ensure all files are the same vs swapping between Windows and Unicode.

Configuration is the same for all 3 repos.

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