Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add JavaDoc to 'Json' classes #12584

Merged
merged 2 commits into from
Aug 23, 2023

Conversation

sbabcoc
Copy link
Contributor

@sbabcoc sbabcoc commented Aug 22, 2023

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

In this PR, I'm adding JavaDoc headers to the classes and methods of Selenium's Json API.

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

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • I have read the contributing document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@sbabcoc sbabcoc force-pushed the pr/add-json-api-javadoc-2 branch from dcb913d to 0f3845c Compare August 22, 2023 07:06
Copy link
Member

@diemol diemol left a comment

Choose a reason for hiding this comment

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

Thank you, @sbabcoc!

@diemol diemol merged commit 6bff9b0 into SeleniumHQ:trunk Aug 23, 2023
@diemol diemol mentioned this pull request Aug 23, 2023
8 tasks
CandorContent pushed a commit to CandorContent/selenium that referenced this pull request Aug 25, 2023
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