[JAVA-1392] Complete Javadoc for driver module Created: 19/Aug/14  Updated: 08/Oct/14  Resolved: 08/Oct/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: Jeffrey Yemin
Resolution: Done Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: Not Specified Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Attachments: File driver-javadoc-errors.rtf    
Sub-Tasks:
Key
Summary
Type
Status
Assignee
JAVA-1410 Complete Javadoc for Legacy API Sub-task Closed Trisha Gee  
JAVA-1411 Complete Javadoc for new API Sub-task Closed Ross Lawley  

 Description   

Ensure all public methods on all public classes have proper Javadoc



 Comments   
Comment by Trisha Gee [ 26/Aug/14 ]

Running the checkstyle check to see what's missing from the Javadoc shows

386 errors.

Mostly missing Javadoc. Report attached.

Running Javadoc with Java 8 gives:
41 errors
24 warnings

It's not possible to run these reports for the two subtasks as the module and package structure is the same for the legacy and new APIs.

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