Skip to content

[JAVA-1453] Applied 3.0 updated documentation to 2.13 code for the com.mongodb package#265

Closed
trishagee wants to merge 3 commits intomongodb:masterfrom
trishagee:JAVA-1453
Closed

[JAVA-1453] Applied 3.0 updated documentation to 2.13 code for the com.mongodb package#265
trishagee wants to merge 3 commits intomongodb:masterfrom
trishagee:JAVA-1453

Conversation

@trishagee
Copy link
Contributor

Used a combination of the same checkstyle rules that we use in 3.x and IntelliJ's inspections to track down missing public class/method documentation and apply changes from the 3.x branch. Deprecated methods are not included, although if javadoc already existed for these methods/classes it has been retained.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is copied from 3.0. This is not currently used in the build, but was used in development for tracking down missing documentation, and can potentially be enabled at a later date.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like you missed my last set of comments on #256 where I requested a change of these bulk write links from shell documentation to the command documentation reference.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't do this comment as part of the last lot of documentation, it was already there from when Bulk was first implemented. But I can make the change in both places if you like.

@jyemin
Copy link
Collaborator

jyemin commented Oct 10, 2014

I didn't go over it with a fine toothcomb as I assumed it was mostly a straight copy of what's already been reviewed. I notice a few things that should be addressed, but overall looks great and will be very helpful to our users and support staff.

@trishagee
Copy link
Contributor Author

Have addressed the specific points, and also I went back over all the changes to make sure I didn't change the visibility of any other classes. Discovered some other minor nits while I was on it so I've address all those. This should be a slightly neater set of changes as I've rolled back some changes that were just noise.

@trishagee
Copy link
Contributor Author

If there aren't any further comments on this, I'll merge it

@jyemin
Copy link
Collaborator

jyemin commented Oct 14, 2014

lgtm

@trishagee
Copy link
Contributor Author

Merged.

@trishagee trishagee closed this Oct 15, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants