docs: Improve Javadoc for HostAndPortMapper (#4112)

[JuneYub]

Improves Javadoc as requested in #4112.
The wiki is deprecated, so I've focused on the code-level documentation.

Closes #4112

[ggivo]

@JuneYub

Improves Javadoc as requested in #4112. The wiki is deprecated, so I've focused on the code-level documentation.

Deprecation goes for "Release Notes" section itself.

My idea is to use the wiki as a dev-friendly doc with more code examples.
Once we have the example wrapped up, we can also consider adding some of them to the official doc.
I suggest adding a coding example under the https://github.com/redis/jedis/wiki/AdvancedUsage section.

cc: @andy-stark-redis

PS: @JuneYub forgot to say, Hi and thanks for the involvement!

[JuneYub]

@ggivo

Hello, thank you for the review.
I've realized that a documentation update is needed to reflect the changes in this PR. Specifically, it seems the AdvancedUsage.md page in the Wiki should be updated.
Since I don't seem to have direct permission to edit the Wiki, I'd like to ask for the best way to propose the documentation changes.
Should I leave the proposed content here as a comment in this PR?
Please let me know the preferred method for the project, and I will proceed accordingly.
Thank you.

[ggivo]

@JuneYub
Ahh.. My bad, wikis are quite outdated. I meant to update https://redis.github.io/jedis/
You can update directly advanced-usage.md and add it to the review,

You can take a look at docs/README.md how to generate docs locally, then advanced-usage should be available at http://0.0.0.0:8000/advanced-usage/

Hope it helps...

[JuneYub]

Hi @ggivo,

Thanks for the feedback!

I have added the documentation for HostAndPortMapper to advanced-usage.md as you requested.

To help users better understand its usage, I've included examples for both implementing it with a dedicated class and using a more concise lambda expression, especially since it's a functional interface.

Please take a look when you have a moment. I'm open to any further suggestions.

Thanks!

[ggivo]

@JuneYub
Looks good overall!

However, as part of our ongoing effort to simplify the API, we’re aiming to reduce the number of public constructors and promote the single constructor that accepts a JedisClientConfig. This approach centralizes multiple connection parameters into a single object (see here) and is the recommended way forward.
I suggest examples provided to be based on DefaultJedisClientConfig (see here) or based on JedisClientConfig (see here) directly.

[JuneYub]

@ggivo
Thanks for the clarification! Updated the docs to use DefaultJedisClientConfig as suggested.
Learned a better approach for simplifying constructor usage.

[Copilot]

Pull Request Overview

This PR improves the documentation for the HostAndPortMapper interface as requested in issue #4112. The changes focus on enhancing code-level documentation since the wiki is deprecated.

• Added comprehensive Javadoc comments to the HostAndPortMapper interface
• Added detailed documentation section in advanced-usage.md explaining the purpose and usage of HostAndPortMapper
• Provided practical examples showing both class-based and lambda-based implementations

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File	Description
src/main/java/redis/clients/jedis/HostAndPortMapper.java	Added interface-level Javadoc and method documentation with @FunctionalInterface annotation
docs/advanced-usage.md	Added comprehensive documentation section with examples for NAT/containerization scenarios

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[ggivo]

@JuneYub
Merged. Thanks for the amazing work.