[JAVA-3803] API docs are confusing Created: 03/Aug/20  Updated: 28/Oct/23  Resolved: 24/Aug/20

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

Type: Improvement Priority: Major - P3
Reporter: Jeffrey Yemin Assignee: Ross Lawley
Resolution: Fixed Votes: 2
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Case:

 Description   

Currently it's very difficult to find the API documentation for any types from mongod-driver-core. They are published (e.g. at http://mongodb.github.io/mongo-java-driver/4.1/apidocs/), but there is no direct link to that, so the only way to get to these types is via links from one of the top-level drivers (e.g. http://mongodb.github.io/mongo-java-driver/4.1/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#countDocuments(com.mongodb.client.ClientSession,org.bson.conversions.Bson,com.mongodb.client.model.CountOptions)). And some classes don't have any direct links to them, e.g. most of the exception types. So they are very difficult to find as a result.

A couple of options to consider:

  1. Just add a link to the mongodb-driver-core API docs to http://mongodb.github.io/mongo-java-driver/4.1/apidocs/
  2. Add the shared types to each of the top-level driver API docs. So there would be four copies of all the shared types published, but they would at least be easy to find from each of the top-level drivers.


 Comments   
Comment by Githook User [ 24/Aug/20 ]

Author:

{'name': 'Ross Lawley', 'email': 'ross.lawley@gmail.com', 'username': 'rozza'}

Message: Docs: Added a link to the shared core (#564)

JAVA-3803
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/a3f1e2efa456d87fad2f582d8c568aa2ae86718b

Comment by Ross Lawley [ 18/Aug/20 ]

PR: https://github.com/mongodb/mongo-java-driver/pull/564

Generated at Thu Feb 08 09:00:28 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.