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: add missing javadoc tags to avoid warnings #1164

Merged
merged 1 commit into from Jun 30, 2018

Conversation

Projects
None yet
4 participants
@lordnelson
Contributor

lordnelson commented Mar 30, 2018

Resolve a small number of warnings when generating the Javadoc

@lordnelson lordnelson force-pushed the lordnelson:javadoc-fixes branch from a6b0d4a to d63f70a Mar 30, 2018

@codecov-io

This comment has been minimized.

codecov-io commented Mar 30, 2018

Codecov Report

Merging #1164 into master will increase coverage by 0.03%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##             master    #1164      +/-   ##
============================================
+ Coverage     69.12%   69.15%   +0.03%     
- Complexity     3789     3791       +2     
============================================
  Files           170      170              
  Lines         15760    15760              
  Branches       2578     2578              
============================================
+ Hits          10894    10899       +5     
+ Misses         3622     3620       -2     
+ Partials       1244     1241       -3

@lordnelson lordnelson force-pushed the lordnelson:javadoc-fixes branch from d63f70a to be149b7 Mar 30, 2018

chore: add missing javadoc tags to avoid warnings
Some missing javadoc tags were generating warnings when building
the documentation. This commit provides those missing tags.

@lordnelson lordnelson force-pushed the lordnelson:javadoc-fixes branch from be149b7 to e79bd0c Apr 27, 2018

@vlsi

This comment has been minimized.

Member

vlsi commented May 15, 2018

@lordnelson , just wondering: is there an option to configure "fail the build in case of javadoc warnings"?

@lordnelson

This comment has been minimized.

Contributor

lordnelson commented May 15, 2018

@vlsi

This comment has been minimized.

Member

vlsi commented May 15, 2018

I'm not sure what is the number of warnings/errors, and if the number is not that high, it could make sense to enable Werror or something like that to avoid more warnings creeping silently into the codebase

@lordnelson

This comment has been minimized.

Contributor

lordnelson commented May 15, 2018

@vlsi

This comment has been minimized.

Member

vlsi commented May 15, 2018

I would appreciate.
We do have checkstyle job at Travis for very similar reasons: it ensures the consistency of the codebase.

@davecramer , what do you think?

@davecramer

This comment has been minimized.

Member

davecramer commented May 22, 2018

@vlsi sorry missed this a week ago. I think it makes sense to be more vigilant about javadoc warnings.
Perhaps like checkstyle we make a mvn task which is optional and builds with -Werror. This would allow people to build even with the errors while they sort things out. In Travis we would enable it.

@lordnelson

This comment has been minimized.

Contributor

lordnelson commented May 29, 2018

I found I can add an additional checkstyle check in checks.xml to fail the build on bad Javadoc style. It found 318 violations. Should I make that change and fix them all in this PR?

@vlsi

This comment has been minimized.

Member

vlsi commented May 29, 2018

Should I make that change and fix them all in this PR?

Technically speaking, I would prefer ensuring checks.xml identifies issues first, then fix those.

On the other hand, feel free to use the approach that fits in your time budget.

@vlsi vlsi added this to the 42.2.3 milestone Jun 30, 2018

@vlsi vlsi merged commit e9ced45 into pgjdbc:master Jun 30, 2018

2 checks passed

codecov/project 69.15% (+0.03%) compared to dde8c02
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

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

chore: add missing javadoc tags to avoid warnings (pgjdbc#1164)
Some missing javadoc tags were generating warnings when building
the documentation. This commit provides those missing tags.

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

chore: add missing javadoc tags to avoid warnings (pgjdbc#1164)
Some missing javadoc tags were generating warnings when building
the documentation. This commit provides those missing tags.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment