[JAVA-1968] Some Java methods are not listing default values Created: 16/Sep/15  Updated: 06/Dec/16  Resolved: 06/Dec/16

Status: Closed
Project: Java Driver
Component/s: Documentation
Affects Version/s: None
Fix Version/s: 3.5.0

Type: Improvement Priority: Minor - P4
Reporter: Daniel Coupal Assignee: Ross Lawley
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

On the following page:
http://api.mongodb.org/java/current/com/mongodb/MongoClientOptions.html
most methods that return time values show the default value.
However some, like the following:

  • getMaxConnectionIdleTime
  • getMaxConnectionLifeTime
  • getHeartbeatFrequency (just putting the default on a separate line should do)
  • getMinHeartbeatFrequency (same as above)
  • getHeartbeatSocketTimeout (same as above)
  • ...
    don't, or are formatted differently.

Note that methods also show Since, but not all of them. Are we consistent with that section?



 Comments   
Comment by Ross Lawley [ 06/Dec/16 ]

Many thanks to vedala for the PR updating the JavaDoc for MongoClientOptions.

Comment by Githook User [ 06/Dec/16 ]

Author:

{u'username': u'vedala', u'name': u'Sundaram Kalyan Vedala', u'email': u'svedala23@gmail.com'}

Message: Update MongoClientOptions Javadoc

Updated javadoc to show default values for a few methods

JAVA-1968
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/3b63f24af5025d397318c378d839dcd8d7cdb711

Comment by Sundaram Kalyan Vedala [ 25/Mar/16 ]

I have opened a pull request for this issue.

Summary of modifications made to MongoClientOptions.java:

Added default value information:

getMaxConnectionIdleTime
getMaxConnectionLifeTime

Default value information moved to a separate line

getDbDecoderFactory
getDbEncoderFactory

Default value information moved to a separate line, modified slightly for consistency

getHeartbeatFrequency
getMinHeartbeatFrequency
getHeartbeatSocketTimeout
isSslEnabled
isSslInvalidHostNameAllowed
getCommandListeners

Default value information already present on separate line, modified slightly for consistency

getHeartbeatConnectTimeout
getLocalThreshold

Default value information modified from false to

{@code false}

isAlwaysUseMBeans
isSocketKeepAlive

Comment by Sundaram Kalyan Vedala [ 25/Mar/16 ]

Thanks, Jeff. I will work on the issue and will update the ticket after my pull request is ready.

Comment by Jeffrey Yemin [ 24/Mar/16 ]

You can't assign it to yourself, but you can open a pull request against the Github project and we'll be happy to consider merging it.

Comment by Sundaram Kalyan Vedala [ 23/Mar/16 ]

I am new to mongodb community. I feel this issue would be a good place to start contributing to mongodb java driver. How can I assign this issue to myself? I hope writing a comment is the right place for query of this kind.

Comment by Jeffrey Yemin [ 16/Sep/15 ]

Generally, we only add the @since Javadoc annotation to methods that were added in releases subsequent to the release that the containing class was introduced, e.g getConnectionsPerHost doesn't have one since it was in the original version of MongoClientOptions.

Generated at Thu Feb 08 08:55:59 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.