[JAVA-1393] Complete Javadoc for bson module Created: 19/Aug/14  Updated: 31/Mar/15  Resolved: 29/Sep/14

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

Type: Improvement Priority: Major - P3
Reporter: Jeffrey Yemin Assignee: Trisha Gee
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Attachments: File bson-javadoc-errors.rtf    

 Description   

Ensure all public classes in bson module have proper Javadoc



 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-1393 Documenting BSON module. First pass complete, all missing javadoc has been added.
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/15b7ebefa736e4f32c8c0f4096124e4f970c6573

Comment by Githook User [ 27/Sep/14 ]

Author:

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

Message: JAVA-1393 Documenting BSON module. First pass complete, all missing javadoc has been added.
Branch: 3.0.x
https://github.com/mongodb/mongo-java-driver/commit/15b7ebefa736e4f32c8c0f4096124e4f970c6573

Comment by Trisha Gee [ 26/Aug/14 ]

First pass of turning on the checkstyle error to ensure public methods and classes are documented gives:

103 errors

It's mostly missing comments.

Report attached.

Running Javadoc using Java 8 gives zero errors or warnings.

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