Finish up JavaDoc for the 'Json' classes #12609
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sbabcoc
force-pushed
the
pr/add-json-api-javadoc-3
branch
2 times, most recently
from
85c556f
to
29cfe26
Compare
shs96c
reviewed
Aug 25, 2023
|
|
||
| this.stack = new ArrayDeque<>(); | ||
| this.stack.addFirst(new Empty()); | ||
| this.stack.addFirst(new Root()); |
There was a problem hiding this comment.
This looks suspicious.... Were things failing? Or is this part of the state-machine work?
There was a problem hiding this comment.
No, this just seems like a more descriptive name for the role this class plays. I can revert this change if you prefer.
sbabcoc
force-pushed
the
pr/add-json-api-javadoc-3
branch
3 times, most recently
from
313cc7f
to
cb7f657
Compare
sbabcoc
commented
Aug 25, 2023
sbabcoc
force-pushed
the
pr/add-json-api-javadoc-3
branch
10 times, most recently
from
94b32db
to
1549519
Compare
sbabcoc
force-pushed
the
pr/add-json-api-javadoc-3
branch
from
1549519
to
9f0f091
Compare
diemol
approved these changes
Aug 28, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Thanks for contributing to Selenium!
A PR well described will help maintainers to quickly review and merge it
Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, help reviewers by making them as simple and short as possible.
Description
This PR finishes up the JavaDoc comments for the classes and methods of Selenium's Json API's.
These were started in PR #12584 and got merge before I was finished.
Motivation and Context
The Selenium Json API is a very useful built-in mechanism for consuming and producing JSON representations of Java objects. This facility can be very useful, especially when interacting with GraphQL web service endpoints, but the lack of documentation can result in considerable confusion.
This PR adds JavaDoc headers to classes, methods, and defined constants to assist folks in using the Selenium Json API in their own code.
Types of changes
Checklist