[JAVA-1391] Complete Javadoc for driver-core Created: 19/Aug/14 Updated: 30/Jan/15 Resolved: 07/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: | Trisha Gee |
| Resolution: | Done | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Attachments: |
|
| Description |
|
Ensure that all public methods in all public classes in driver-core have proper Javadoc |
| Comments |
| Comment by Githook User [ 30/Jan/15 ] |
|
Author: {u'username': u'jyemin', u'name': u'Jeff Yemin', u'email': u'jeff.yemin@10gen.com'}Message: Completed Javadoc for the driver-core module of almost all public classes and public or protected members.
|
| Comment by Githook User [ 30/Jan/15 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| 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-1391/2/3] Fixed Javadoc so it builds under Java 8. |
| Comment by Githook User [ 30/Jan/15 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Githook User [ 30/Jan/15 ] |
|
Author: {u'username': u'jyemin', u'name': u'Jeff Yemin', u'email': u'jeff.yemin@10gen.com'}Message: |
| Comment by Githook User [ 30/Jan/15 ] |
|
Author: {u'username': u'jyemin', u'name': u'Jeff Yemin', u'email': u'jeff.yemin@10gen.com'}Message: |
| Comment by Githook User [ 30/Jan/15 ] |
|
Author: {u'username': u'jyemin', u'name': u'Jeff Yemin', u'email': u'jeff.yemin@10gen.com'}Message: |
| 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 #242 from trishagee/
|
| 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 #242 from trishagee/
|
| Comment by Githook User [ 30/Jan/15 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Githook User [ 30/Jan/15 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Githook User [ 30/Jan/15 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Githook User [ 30/Jan/15 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Githook User [ 30/Jan/15 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Githook User [ 30/Jan/15 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Githook User [ 30/Jan/15 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Githook User [ 30/Jan/15 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Trisha Gee [ 02/Oct/14 ] |
|
This is still not complete. Checkstyle is showing the following missing documentation: com/mongodb/assertions/Assertions.java:66:5: Missing a Javadoc comment. When all the documentation has been completed, line 25 from checkstyle-exclude.xml can be removed and the "check" task should complete successfully. |
| Comment by Githook User [ 29/Sep/14 ] |
|
Author: {u'username': u'jyemin', u'name': u'Jeff Yemin', u'email': u'jeff.yemin@10gen.com'}Message: Completed Javadoc for the driver-core module of almost all public classes and public or protected members.
|
| Comment by Githook User [ 12/Sep/14 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Githook User [ 10/Sep/14 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: [JAVA-1391/2/3] Fixed Javadoc so it builds under Java 8. |
| Comment by Githook User [ 05/Sep/14 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Githook User [ 05/Sep/14 ] |
|
Author: {u'username': u'jyemin', u'name': u'Jeff Yemin', u'email': u'jeff.yemin@10gen.com'}Message: |
| Comment by Githook User [ 05/Sep/14 ] |
|
Author: {u'username': u'jyemin', u'name': u'Jeff Yemin', u'email': u'jeff.yemin@10gen.com'}Message: |
| Comment by Githook User [ 05/Sep/14 ] |
|
Author: {u'username': u'jyemin', u'name': u'Jeff Yemin', u'email': u'jeff.yemin@10gen.com'}Message: |
| Comment by Githook User [ 04/Sep/14 ] |
|
Author: {u'username': u'jyemin', u'name': u'Jeff Yemin', u'email': u'jeff.yemin@10gen.com'}Message: |
| Comment by Githook User [ 04/Sep/14 ] |
|
Author: {u'username': u'jyemin', u'name': u'Jeff Yemin', u'email': u'jeff.yemin@10gen.com'}Message: |
| Comment by Githook User [ 04/Sep/14 ] |
|
Author: {u'username': u'jyemin', u'name': u'Jeff Yemin', u'email': u'jeff.yemin@10gen.com'}Message: |
| 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 #242 from trishagee/
|
| 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 #242 from trishagee/
|
| Comment by Githook User [ 03/Sep/14 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Githook User [ 03/Sep/14 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Githook User [ 03/Sep/14 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Githook User [ 03/Sep/14 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Githook User [ 03/Sep/14 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Githook User [ 03/Sep/14 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Githook User [ 03/Sep/14 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Githook User [ 03/Sep/14 ] |
|
Author: {u'username': u'trishagee', u'name': u'Trisha Gee', u'email': u'trishagee@github.com'}Message: |
| Comment by Trisha Gee [ 26/Aug/14 ] |
|
First pass of running the checkstyle rule to enforce Javadoc on public methods and classes in driver-core: 559 Errors Mostly missing Javadoc, with some errors on existing javadoc (report attached). Also, running Javadoc with Java 8 gives the following: There's not much overlap between the 531 errors in the first case and the 45 errors in the second, since Java 8 introduces new strict HTML checking. |