Complete Javadoc for driver module (JAVA-1392)

[JAVA-1411] Complete Javadoc for new API Created: 26/Aug/14  Updated: 31/Mar/15  Resolved: 02/Oct/14

Status: Closed
Project: Java Driver
Component/s: API, Documentation
Affects Version/s: None
Fix Version/s: 3.0.0

Type: Sub-task Priority: Major - P3
Reporter: Trisha Gee Assignee: Ross Lawley
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

The driver module is made up of two APIs, the existing API (DBObject, DBCollection, DB) and the new CRUD API.

This ticket is to Javadoc all public classes and methods on the new CRUD API.



 Comments   
Comment by Jeffrey Yemin [ 31/Mar/15 ]

Closing all resolved 3.0.0 issues, as 3.0.0 has been tagged and released.

Comment by Githook User [ 30/Jan/15 ]

Author:

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

Message: Documentation updates for com.mongodb.client

JAVA-1411
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/d29f0c44ee2840722d455e6cad52976ba24f0c01

Comment by Githook User [ 02/Oct/14 ]

Author:

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

Message: Documentation updates for com.mongodb.client

JAVA-1411
Branch: 3.0.x
https://github.com/mongodb/mongo-java-driver/commit/d29f0c44ee2840722d455e6cad52976ba24f0c01

Comment by Trisha Gee [ 29/Sep/14 ]

I see the following errors:

driver:checkstyleMain
com/mongodb/client/MongoCollection.java:99:61: Expected @param tag for 'options'.
com/mongodb/client/MongoCollection.java:116:6: Expected @param tag for '<C>'.
com/mongodb/client/MongoCollection.java:135:6: Expected @param tag for '<C>'.
com/mongodb/client/MongoCollection.java:156:6: Expected @param tag for '<C>'.
com/mongodb/client/MongoCollection.java:179:6: Expected @param tag for '<C>'.
com/mongodb/client/MongoCollection.java:211:6: Expected @param tag for '<C>'.
com/mongodb/client/MongoCollection.java:223:6: Expected @param tag for '<C>'.
com/mongodb/client/MongoCollection.java:479:6: Expected @param tag for '<C>'.
com/mongodb/client/MongoCollection.java:490:6: Expected @param tag for '<C>'.
com/mongodb/client/MongoCollectionOptions.java:24: Missing a Javadoc comment.
com/mongodb/client/MongoCollectionOptions.java:26:5: Missing a Javadoc comment.
com/mongodb/client/MongoCollectionOptions.java:30:5: Missing a Javadoc comment.
com/mongodb/client/MongoCollectionOptions.java:38: Missing a Javadoc comment.
com/mongodb/client/MongoCollectionOptions.java:39:9: Missing a Javadoc comment.
com/mongodb/client/MongoDatabase.java:28:5: Missing a Javadoc comment.
com/mongodb/client/MongoDatabase.java:30:5: Missing a Javadoc comment.
com/mongodb/client/MongoDatabase.java:32:5: Missing a Javadoc comment.
com/mongodb/client/MongoDatabase.java:34:5: Missing a Javadoc comment.
com/mongodb/client/MongoDatabase.java:36:5: Missing a Javadoc comment.
com/mongodb/client/MongoDatabase.java:38:5: Missing a Javadoc comment.
com/mongodb/client/MongoDatabase.java:40:5: Missing a Javadoc comment.
com/mongodb/client/MongoDatabase.java:42:5: Missing a Javadoc comment.
com/mongodb/client/MongoDatabase.java:44:5: Missing a Javadoc comment.
com/mongodb/client/MongoDatabaseOptions.java:27: Missing a Javadoc comment.
com/mongodb/client/MongoDatabaseOptions.java:33:5: Missing a Javadoc comment.
com/mongodb/client/MongoDatabaseOptions.java:37:5: Missing a Javadoc comment.
com/mongodb/client/MongoDatabaseOptions.java:45:5: Missing a Javadoc comment.
com/mongodb/client/MongoDatabaseOptions.java:49:5: Missing a Javadoc comment.
com/mongodb/client/MongoDatabaseOptions.java:53:5: Missing a Javadoc comment.
com/mongodb/client/MongoDatabaseOptions.java:57: Missing a Javadoc comment.
com/mongodb/client/MongoDatabaseOptions.java:62:9: Missing a Javadoc comment.
com/mongodb/client/MongoDatabaseOptions.java:66:9: Missing a Javadoc comment.
com/mongodb/client/MongoDatabaseOptions.java:70:9: Missing a Javadoc comment.
com/mongodb/client/MongoDatabaseOptions.java:74:9: Missing a Javadoc comment.
com/mongodb/client/MongoDatabaseOptions.java:79:9: Missing a Javadoc comment.
com/mongodb/client/MongoDatabaseOptions.java:84:9: Missing a Javadoc comment.
com/mongodb/client/MongoDatabaseOptions.java:89:9: Missing a Javadoc comment.
com/mongodb/client/QueryBuilder.java:29: Missing a Javadoc comment.

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