Skip to content

Comments

Add javadoc for library#6

Merged
lothar1998 merged 3 commits intomasterfrom
javadoc
May 11, 2025
Merged

Add javadoc for library#6
lothar1998 merged 3 commits intomasterfrom
javadoc

Conversation

@lothar1998
Copy link
Owner

No description provided.

@lothar1998 lothar1998 requested a review from Copilot May 9, 2025 22:10
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

@lothar1998 lothar1998 merged commit 9d35bd1 into master May 11, 2025
2 checks passed
@lothar1998 lothar1998 deleted the javadoc branch May 11, 2025 18:36
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.

1 participant