[JAVA-2237] Broken MongoDB documentation links in API docs Created: 30/Jun/16  Updated: 01/Dec/16  Resolved: 08/Jul/16

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

Type: Bug Priority: Minor - P4
Reporter: Kamran K. Assignee: Ross Lawley
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

There are some API docs that use "reference/commands" instead of "reference/command" in MongoDB documentation URLs:

driver/src/main/com/mongodb/client/MongoCollection.java:597:     * @mongodb.driver.manual reference/commands/renameCollection Rename collection
driver/src/main/com/mongodb/client/MongoCollection.java:608:     * @mongodb.driver.manual reference/commands/renameCollection Rename collection
driver/src/main/com/mongodb/client/MongoDatabase.java:170:     * @mongodb.driver.manual reference/commands/dropDatabase/#dbcmd.dropDatabase Drop database
driver/src/main/com/mongodb/client/MongoDatabase.java:203:     * @mongodb.driver.manual reference/commands/create Create Command
driver/src/main/com/mongodb/client/MongoDatabase.java:212:     * @mongodb.driver.manual reference/commands/create Create Command
driver/src/main/com/mongodb/MongoClient.java:310:     * @mongodb.driver.manual reference/commands/listDatabases List Databases
driver-async/src/main/com/mongodb/async/client/MongoClient.java:61:     * @mongodb.driver.manual reference/commands/listDatabases List Databases
driver-async/src/main/com/mongodb/async/client/MongoCollection.java:608:     * @mongodb.driver.manual reference/commands/renameCollection Rename collection
driver-async/src/main/com/mongodb/async/client/MongoCollection.java:620:     * @mongodb.driver.manual reference/commands/renameCollection Rename collection
driver-async/src/main/com/mongodb/async/client/MongoDatabase.java:173:     * @mongodb.driver.manual reference/commands/dropDatabase/#dbcmd.dropDatabase Drop database
driver-async/src/main/com/mongodb/async/client/MongoDatabase.java:207:     * @mongodb.driver.manual reference/commands/create Create Command
driver-async/src/main/com/mongodb/async/client/MongoDatabase.java:217:     * @mongodb.driver.manual reference/commands/create Create Command

An example broken link is the "Rename collection" link at the bottom of http://api.mongodb.com/java/3.2/com/mongodb/async/client/MongoCollection.html#renameCollection-com.mongodb.MongoNamespace-com.mongodb.async.SingleResultCallback-



 Comments   
Comment by Githook User [ 01/Dec/16 ]

Author:

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

Message: Javadoc: Fix broken documentation links

JAVA-2237
Branch: refs/tags/r3.3.0
https://github.com/mongodb/mongo-java-driver/commit/d6b49e125d075efc9f24619d1b1c8b6f16166828

Comment by Githook User [ 08/Jul/16 ]

Author:

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

Message: Javadoc: Fix broken documentation links

JAVA-2237
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/d6b49e125d075efc9f24619d1b1c8b6f16166828

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