Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive Javadoc documentation across multiple classes and methods in the Kubernetes resolver library. The key changes include:
- Detailed class- and method-level documentation for secure, insecure, and in-cluster endpoint watchers.
- Expanded Javadoc for the name resolver components and the target parser.
- Consistent documentation updates across several files to aid understanding and maintainability.
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| lib/src/main/java/io/github/lothar1998/kuberesolver/kubernetes/SecureEndpointSliceWatcher.java | Added class-level and method-level Javadoc for secure endpoint watching. |
| lib/src/main/java/io/github/lothar1998/kuberesolver/kubernetes/InsecureEndpointSliceWatcher.java | Introduced Javadoc documenting insecure communication and API usage. |
| lib/src/main/java/io/github/lothar1998/kuberesolver/kubernetes/InClusterEndpointSliceWatcher.java | Documented in-cluster configuration and authentication details. |
| lib/src/main/java/io/github/lothar1998/kuberesolver/kubernetes/EndpointSliceWatcher.java | Enhanced documentation on event watching and error handling. |
| lib/src/main/java/io/github/lothar1998/kuberesolver/ResolverTarget.java | Added Javadoc for target parsing with examples of supported formats. |
| lib/src/main/java/io/github/lothar1998/kuberesolver/KubernetesNameResolverProvider.java | Introduced clear documentation for the NameResolverProvider implementation. |
| lib/src/main/java/io/github/lothar1998/kuberesolver/KubernetesNameResolver.java | Provided detailed Javadoc for name resolution, executor usage, and address building. |
Comments suppressed due to low confidence (1)
lib/src/main/java/io/github/lothar1998/kuberesolver/ResolverTarget.java:7
- [nitpick] Consider clarifying the behavior when the port is missing in the input URI (for example, whether it defaults to null) to improve developer understanding.
/** Represents a parsed Kubernetes target including service name, namespace, and optional port.
lib/src/main/java/io/github/lothar1998/kuberesolver/kubernetes/SecureEndpointSliceWatcher.java
Show resolved
Hide resolved
...rc/main/java/io/github/lothar1998/kuberesolver/kubernetes/InClusterEndpointSliceWatcher.java
Show resolved
Hide resolved
lib/src/main/java/io/github/lothar1998/kuberesolver/KubernetesNameResolver.java
Show resolved
Hide resolved
This file contains hidden or 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
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.
No description provided.