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

fix javadocs #792

Merged
merged 2 commits into from
Jun 30, 2018
Merged

fix javadocs #792

merged 2 commits into from
Jun 30, 2018

Conversation

davecramer
Copy link
Member

No description provided.

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

Choose a reason for hiding this comment

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

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.

Copy link
Member Author

Choose a reason for hiding this comment

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

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
Copy link
Member Author

davecramer commented Mar 24, 2017 via email

@vlsi
Copy link
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
Copy link
Member Author

@vlsi did you resolve this question ?

@vlsi
Copy link
Member

vlsi commented Sep 25, 2017

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

@codecov-io
Copy link

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 added this to the 42.2.3 milestone Jun 30, 2018
@vlsi vlsi merged commit 825c092 into pgjdbc:master Jun 30, 2018
@davecramer davecramer deleted the fixjavadocs branch February 1, 2022 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants