-
Notifications
You must be signed in to change notification settings - Fork 842
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
fix javadocs #792
Conversation
/* | ||
* Whats the number of columns in the ResultSet? | ||
/** | ||
* What's the number of columns in the ResultSet? |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
@OverRide it is then, as there is nothing additional
Dave Cramer
…On 24 March 2017 at 15:02, Vladimir Sitnikov ***@***.***> wrote:
***@***.**** requested changes on this pull request.
------------------------------
In pgjdbc/src/main/java/org/postgresql/jdbc/PgResultSetMetaData.java
<#792 (comment)>:
> @@ -37,25 +37,22 @@ public PgResultSetMetaData(BaseConnection connection, Field[] fields) {
fieldInfoFetched = false;
}
- /*
- * Whats the number of columns in the ResultSet?
+ /**
+ * What's the number of columns in the ResultSet?
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.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#792 (review)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAYz9kp18bgPBHRJaV5289rO11q7n4Hpks5rpBM9gaJpZM4MonZf>
.
|
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. |
@vlsi did you resolve this question ? |
|
4421910
to
7d9ad20
Compare
Codecov Report
@@ 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 |
No description provided.