Complete Javadoc for driver module (JAVA-1392)

[JAVA-1410] Complete Javadoc for Legacy API Created: 26/Aug/14  Updated: 31/Mar/15  Resolved: 08/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: Trisha Gee
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 existing (legacy) 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'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Fixed @mongodb.driver.manual tags for mongo-wire-protocol links
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/e83a8b1f7950dce9bcf6ab99b5fd73d8950e6534

Comment by Githook User [ 30/Jan/15 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Adding @mongodb.driver.manual tag to classes in com.mongodb
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/0baca6071c6065f0441e92d79da7f84ec07136e3

Comment by Githook User [ 30/Jan/15 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Documenting org.bson.BSON;
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/539392112b6f6c6f120574962738bb14d670ffe1

Comment by Githook User [ 30/Jan/15 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Documenting org.bson.BSON; refactoring BSONOldTest so that encoding and decoding hooks are more clearly tested/documented; made StringRangeSet package protected, moved it into the package that needs it, and massively simplified it; added a test for ClassMap to clearly document its functionality.
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/09110369ccd01b0916ff3536641e3daddac83a28

Comment by Githook User [ 30/Jan/15 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 documenting encoders/decoders.
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/412db2479b26194f31bbb3c56afaa9e2947c1b4a

Comment by Githook User [ 30/Jan/15 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Documenting com.mongodb.util
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/c355af2d79b12eab77aeb0be4be17357110497d9

Comment by Githook User [ 30/Jan/15 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Documenting com.mongodb.gridfs
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/c063c6a17483d3cf17b4faf7d5cb3640f0f01245

Comment by Githook User [ 30/Jan/15 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Javadoc for com.mongodb package. All missing Javadoc covered except for DBEncoder/Decoder-related classes; some gradle changes to prevent errors with the javadoc check.
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/37e8509e4a0b89b97e1131dbc822f24ae24c3b48

Comment by Githook User [ 30/Jan/15 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trisha.gee@10gen.com'}

Message: Merge pull request #243 from trishagee/JAVA-1410

JAVA-1410: First batch of Javadoc for legacy API
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/355f5ff84b8b2f330a346763eac9971ea6739607

Comment by Githook User [ 30/Jan/15 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trisha.gee@10gen.com'}

Message: Merge pull request #243 from trishagee/JAVA-1410

JAVA-1410: First batch of Javadoc for legacy API
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/355f5ff84b8b2f330a346763eac9971ea6739607

Comment by Githook User [ 30/Jan/15 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Fixes from Jeff's suggestions: improvements to the documentation contents and added test for getCollectionFromString which disappeared in the 3.0 migration.
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/5248facafe56c813d533c74c3e9caf44433ebdc2

Comment by Githook User [ 30/Jan/15 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Fixes from Ross's suggestions: tidying DBCursor code.
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/ca3f91f277dbc10aada10248519da136654e6b80

Comment by Githook User [ 30/Jan/15 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Fixes from Ross's suggestions: updated docs for createCollection, removed a duplicate test for createCollection and added a new test to show what happens if the collection already exists.
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/3897cd9f18c6618d33582f728c746a6b9a16f34f

Comment by Githook User [ 30/Jan/15 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Javadoc for Legacy API. Added missing javadoc, tidied some of the existing (particularly capitalisation), renamed some parameters for ease of reading. Also removed the UnknownHostException that is declared on a lot of the Mongo methods as this is never actually thrown.
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/a720792dde66fc6c496ecd5613adcbc80772fcb3

Comment by Githook User [ 30/Jan/15 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Updating Javadoc for legacy public API. Added Javadoc for missing classes and methods, and for the com.mongodb package, but also updated content and formatting for some of the key existing functionality.
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/2963e92920c212cc85248287ed24010fd645e3c6

Comment by Githook User [ 08/Oct/14 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Fixed @mongodb.driver.manual tags for mongo-wire-protocol links
Branch: 3.0.x
https://github.com/mongodb/mongo-java-driver/commit/e83a8b1f7950dce9bcf6ab99b5fd73d8950e6534

Comment by Githook User [ 08/Oct/14 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Adding @mongodb.driver.manual tag to classes in com.mongodb
Branch: 3.0.x
https://github.com/mongodb/mongo-java-driver/commit/0baca6071c6065f0441e92d79da7f84ec07136e3

Comment by Githook User [ 22/Sep/14 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Documenting org.bson.BSON;
Branch: 3.0.x
https://github.com/mongodb/mongo-java-driver/commit/539392112b6f6c6f120574962738bb14d670ffe1

Comment by Githook User [ 19/Sep/14 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Documenting org.bson.BSON; refactoring BSONOldTest so that encoding and decoding hooks are more clearly tested/documented; made StringRangeSet package protected, moved it into the package that needs it, and massively simplified it; added a test for ClassMap to clearly document its functionality.
Branch: 3.0.x
https://github.com/mongodb/mongo-java-driver/commit/09110369ccd01b0916ff3536641e3daddac83a28

Comment by Githook User [ 18/Sep/14 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 documenting encoders/decoders.
Branch: 3.0.x
https://github.com/mongodb/mongo-java-driver/commit/412db2479b26194f31bbb3c56afaa9e2947c1b4a

Comment by Githook User [ 17/Sep/14 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Documenting com.mongodb.util
Branch: 3.0.x
https://github.com/mongodb/mongo-java-driver/commit/c355af2d79b12eab77aeb0be4be17357110497d9

Comment by Githook User [ 12/Sep/14 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Documenting com.mongodb.gridfs
Branch: 3.0.x
https://github.com/mongodb/mongo-java-driver/commit/c063c6a17483d3cf17b4faf7d5cb3640f0f01245

Comment by Githook User [ 05/Sep/14 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Javadoc for com.mongodb package. All missing Javadoc covered except for DBEncoder/Decoder-related classes; some gradle changes to prevent errors with the javadoc check.
Branch: 3.0.x
https://github.com/mongodb/mongo-java-driver/commit/37e8509e4a0b89b97e1131dbc822f24ae24c3b48

Comment by Trisha Gee [ 03/Sep/14 ]

As per the pull request for content covered so far, there's existing documentation that needs more detailed information from someone:

BasicBSONList, line 25
Cursor, line 22
DB, line 168
DBCursor, line 507

Comment by Githook User [ 03/Sep/14 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trisha.gee@10gen.com'}

Message: Merge pull request #243 from trishagee/JAVA-1410

JAVA-1410: First batch of Javadoc for legacy API
Branch: 3.0.x
https://github.com/mongodb/mongo-java-driver/commit/355f5ff84b8b2f330a346763eac9971ea6739607

Comment by Githook User [ 03/Sep/14 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trisha.gee@10gen.com'}

Message: Merge pull request #243 from trishagee/JAVA-1410

JAVA-1410: First batch of Javadoc for legacy API
Branch: 3.0.x
https://github.com/mongodb/mongo-java-driver/commit/355f5ff84b8b2f330a346763eac9971ea6739607

Comment by Githook User [ 03/Sep/14 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Fixes from Jeff's suggestions: improvements to the documentation contents and added test for getCollectionFromString which disappeared in the 3.0 migration.
Branch: 3.0.x
https://github.com/mongodb/mongo-java-driver/commit/5248facafe56c813d533c74c3e9caf44433ebdc2

Comment by Githook User [ 03/Sep/14 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Fixes from Ross's suggestions: tidying DBCursor code.
Branch: 3.0.x
https://github.com/mongodb/mongo-java-driver/commit/ca3f91f277dbc10aada10248519da136654e6b80

Comment by Githook User [ 03/Sep/14 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Fixes from Ross's suggestions: updated docs for createCollection, removed a duplicate test for createCollection and added a new test to show what happens if the collection already exists.
Branch: 3.0.x
https://github.com/mongodb/mongo-java-driver/commit/3897cd9f18c6618d33582f728c746a6b9a16f34f

Comment by Githook User [ 03/Sep/14 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Javadoc for Legacy API. Added missing javadoc, tidied some of the existing (particularly capitalisation), renamed some parameters for ease of reading. Also removed the UnknownHostException that is declared on a lot of the Mongo methods as this is never actually thrown.
Branch: 3.0.x
https://github.com/mongodb/mongo-java-driver/commit/a720792dde66fc6c496ecd5613adcbc80772fcb3

Comment by Githook User [ 03/Sep/14 ]

Author:

{u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}

Message: JAVA-1410 Updating Javadoc for legacy public API. Added Javadoc for missing classes and methods, and for the com.mongodb package, but also updated content and formatting for some of the key existing functionality.
Branch: 3.0.x
https://github.com/mongodb/mongo-java-driver/commit/2963e92920c212cc85248287ed24010fd645e3c6

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