Improve comments related HTTP headers

[gcatanese]

Minor PR to improve comments and geneated javadoc

[gemini-code-assist]

Summary of Changes

Hello @gcatanese, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request primarily focuses on enhancing the documentation within the Adyen Java API Library. It introduces comprehensive Javadoc comments for the RequestOptions class, detailing its purpose and the functionality of its various methods for handling HTTP headers. Additionally, it refines a related API summary template to provide a more precise description of the RequestOptions object's role, ensuring better understanding for developers using the library.

Highlights

• Improved Javadoc Comments: Extensive Javadoc comments have been added to the RequestOptions.java file, providing clear explanations for the class itself, its builder methods, and all getter/setter methods related to HTTP headers.
• Clarified RequestOptions Description: The description of the requestOptions parameter in the api_summary.mustache template has been updated to explicitly state that it stores 'additional HTTP headers', enhancing clarity for generated API documentation.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request improves the Javadoc comments for the RequestOptions class and updates a related template file. The changes are good and make the purpose of the RequestOptions class clearer. I've added several suggestions to further improve the Javadoc comments for the getters and setters in RequestOptions.java to make them more descriptive and consistent with the existing builder methods. I also suggested a potential improvement regarding the use of the Map interface over HashMap for better flexibility.