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

fix javadocs #792

Merged
merged 2 commits into from Jun 30, 2018

Conversation

Projects
None yet
3 participants
@davecramer
Member

davecramer commented Mar 24, 2017

No description provided.

/*
* Whats the number of columns in the ResultSet?
/**
* What's the number of columns in the ResultSet?

This comment has been minimized.

@vlsi

vlsi Mar 24, 2017

Member

Is the javadoc intentionally different from the base class documentation?

I think it might be better to mark the method with @Override and trim the documentation provided it adds nothing special to the ResultSetMetaData documentation.

AFAIK, pgjdbc build procedure inherits JDK documentation.

This comment has been minimized.

@davecramer

davecramer Oct 6, 2017

Member

AFAICT the only reason to have documentation in the implementation is for clarity when reading the implementation. javadoc should automatically inherit the interface docs. Unless of course as you mentioned there is something special about the implementation.

@davecramer

This comment has been minimized.

Member

davecramer commented Mar 24, 2017

@vlsi

This comment has been minimized.

Member

vlsi commented Mar 24, 2017

It looks like I'm not quite right with documentation inheritance. I need to check my build setup.

http://static.javadoc.io/org.postgresql/postgresql/42.0.0/org/postgresql/jdbc/PgResultSet.html#getByte-int- seems to miss documentation.

@davecramer

This comment has been minimized.

Member

davecramer commented May 23, 2017

@vlsi did you resolve this question ?

@vlsi

This comment has been minimized.

Member

vlsi commented Sep 25, 2017

  1. @davecramer , please rebase
  2. I need to check why javadoc inheritance is not working properly

@davecramer davecramer force-pushed the davecramer:fixjavadocs branch from 4421910 to 7d9ad20 Oct 6, 2017

@codecov-io

This comment has been minimized.

codecov-io commented Oct 6, 2017

Codecov Report

Merging #792 into master will increase coverage by <.01%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##             master     #792      +/-   ##
============================================
+ Coverage     65.94%   65.95%   +<.01%     
  Complexity     3562     3562              
============================================
  Files           166      166              
  Lines         15244    15244              
  Branches       2465     2465              
============================================
+ Hits          10053    10054       +1     
+ Misses         4022     4020       -2     
- Partials       1169     1170       +1

@vlsi vlsi force-pushed the pgjdbc:master branch from 4a6d1d1 to 5819f31 Jan 17, 2018

davecramer added some commits Mar 24, 2017

@vlsi vlsi force-pushed the davecramer:fixjavadocs branch from 7d9ad20 to b1733cb Jun 30, 2018

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

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

1 check was pending

continuous-integration/travis-ci/pr The Travis CI build is in progress
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