[JAVA-3091] Produce separate Javadoc trees for the different drivers Created: 14/Nov/18  Updated: 28/Oct/23  Resolved: 03/Feb/20

Status: Closed
Project: Java Driver
Component/s: Build, Documentation
Affects Version/s: None
Fix Version/s: 4.0.0

Type: Improvement Priority: Major - P3
Reporter: Daniel Coupal Assignee: Ross Lawley
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
depends on JAVA-1711 Automate publishing to GitHub pages Closed

 Description   

When using the Java driver, you need to decide which one of the 3 different ones you will use. Then you select the one you want from the drop down menu at:
  https://mongodb.github.io/mongo-java-driver/

After installing the driver, if you need information about the classes and search for a given class in the Java docs at:

  http://mongodb.github.io/mongo-java-driver

You see only one set of docs for the 3 products.
Taking a "MongoClient" object for example; in one driver it is an interface and a class in another. The listed methods are not available in all drivers, so it is confusing if you use the Javadocs to see what you can do on an object

I think we should have 3 sets of Javadocs, one per downloadable driver.
It could be something like the following:

http://mongodb.github.io/mongo-java-driver/mongodb-driver-sync/<versions>
http://mongodb.github.io/mongo-java-driver/mongodb-driver-async/<versions>
http://mongodb.github.io/mongo-java-driver/mongodb-driver-legacy/<versions>

As a user, I would see the docs that match the product I am using.

 



 Comments   
Comment by Githook User [ 03/Feb/20 ]

Author:

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

Message: Java/ScalaDoc: Now publishing separate docs per project.

JAVA-3091
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/d6e3fa55da83ccc24e83e3db50eaaa49887b1250

Comment by Ross Lawley [ 29/Jan/20 ]

PR: https://github.com/rozza/mongo-java-driver/pull/358

Comment by Daniel Coupal [ 14/Nov/18 ]

Thanks ross.lawley

We may change our course to use 3.9.0.

It would make it easier for the student if they have a matching documentation.

Comment by Ross Lawley [ 14/Nov/18 ]

Please note as each jar is published with its own javadoc and source jar, so you can use javadoc.io while waiting for this ticket to be fixed :

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