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

chore: Correct the Javadoc and enforce with Checkstyle #1236

Merged
merged 6 commits into from Jul 5, 2018

Conversation

Projects
None yet
4 participants
@lordnelson
Copy link
Contributor

lordnelson commented Jul 1, 2018

The attached PR contains the commits to enable the Checkstyle Javadoc rules on the codebase and the corresponding changes to make the existing Javadoc compliant.

@lordnelson

This comment has been minimized.

Copy link
Contributor Author

lordnelson commented Jul 1, 2018

This PR contains additional Javadoc fixes on top of #1164

@lordnelson lordnelson force-pushed the lordnelson:javadoc-fixes branch from 45732b8 to 8158cd3 Jul 1, 2018

@codecov-io

This comment has been minimized.

Copy link

codecov-io commented Jul 1, 2018

Codecov Report

Merging #1236 into master will decrease coverage by 0.01%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##             master   #1236      +/-   ##
===========================================
- Coverage     68.71%   68.7%   -0.02%     
+ Complexity     3836    3835       -1     
===========================================
  Files           173     173              
  Lines         15996   15996              
  Branches       2609    2609              
===========================================
- Hits          10992   10990       -2     
  Misses         3775    3775              
- Partials       1229    1231       +2

@lordnelson lordnelson changed the title chore: Correct the Javadoc and enforce with Checkstyle WIP chore: Correct the Javadoc and enforce with Checkstyle Jul 3, 2018

@lordnelson lordnelson changed the title WIP chore: Correct the Javadoc and enforce with Checkstyle chore: Correct the Javadoc and enforce with Checkstyle Jul 3, 2018

@lordnelson lordnelson force-pushed the lordnelson:javadoc-fixes branch from be57070 to 7fe7c8e Jul 3, 2018

@lordnelson lordnelson closed this Jul 4, 2018

@lordnelson lordnelson reopened this Jul 4, 2018

@lordnelson

This comment has been minimized.

Copy link
Contributor Author

lordnelson commented Jul 4, 2018

@vlsi is there a way to rebuild this PR? I think it failed due to some test failure that was nothing to do with my changes.

@vlsi

This comment has been minimized.

Copy link
Member

vlsi commented Jul 4, 2018

testDuringSendBigTransactionConnectionCloseSlotStatusNotActive seems to be unstable for some reason

@vlsi

This comment has been minimized.

Copy link
Member

vlsi commented Jul 4, 2018

@lordnelson , do you consider this PR "feature complete"?

@vlsi

This comment has been minimized.

Copy link
Member

vlsi commented Jul 4, 2018

I've just checked that this PR passes <failOnWarnings>true</failOnWarnings> javadoc build, and it does improve javadoc readability (e.g. current Driver#connect doc is hard to read http://static.javadoc.io/org.postgresql/postgresql/42.2.2/org/postgresql/Driver.html#connect-java.lang.String-java.util.Properties- )

I'm inclined to merge this (and add <failOnWarnings>true</failOnWarnings> to the parent poms) otherwise we'll have to rebase it again and again as new commits get merged to master.

Any thoughts?

@davecramer

This comment has been minimized.

Copy link
Member

davecramer commented Jul 4, 2018

I'm in agreement with merging this ASAP it's such a big patch rebasing it will only get more difficult with time

+1

@lordnelson

This comment has been minimized.

Copy link
Contributor Author

lordnelson commented Jul 4, 2018

Hi @vlsi yeah I consider this part of it feature complete. If we want to further uncomment the checkstyle checks to mirror that expected by Google style they can form a future PR.

If you want to merge other PRs first, I'm happy to keep rebasing on master to ensure it still passes.

@vlsi vlsi force-pushed the lordnelson:javadoc-fixes branch from 56ac8c5 to 7fe7c8e Jul 5, 2018

@vlsi vlsi added this to the 42.2.3 milestone Jul 5, 2018

@vlsi vlsi merged commit 08631cc into pgjdbc:master Jul 5, 2018

0 of 2 checks passed

codecov/project 68.7% (-0.02%) compared to e19ee7a
Details
continuous-integration/travis-ci/pr The Travis CI build failed
Details

rhavermans added a commit to bolcom/pgjdbc that referenced this pull request Jul 13, 2018

rhavermans added a commit to bolcom/pgjdbc that referenced this pull request Jul 13, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.