Add JavaDoc with Example Usage to classes and non-private methods#92
Merged
mercyblitz merged 7 commits intomainfrom Mar 22, 2026
Merged
Add JavaDoc with Example Usage to classes and non-private methods#92mercyblitz merged 7 commits intomainfrom
mercyblitz merged 7 commits intomainfrom
Conversation
…classes Add JavaDoc to non-private methods missing documentation in: - ReactiveDiscoveryClientAdapter: constructor, description(), getInstances(), getServices(), probe(), getOrder() - UnionDiscoveryClient: description(), getInstances(), getServices(), getDiscoveryClients(), getOrder(), afterSingletonsInstantiated(), destroy(), setApplicationContext() - DiscoveryClientAutoConfiguration: unionDiscoveryClient() bean method - ReactiveDiscoveryClientAutoConfiguration: reactiveDiscoveryClientAdapter() bean method Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add comprehensive JavaDoc documentation to non-private methods that were missing it in the service registry package: - InMemoryServiceRegistry: all @OverRide methods and getMetadata() - MultipleAutoServiceRegistration: constructor and all @OverRide methods - MultipleRegistration: constructor, all @OverRide methods, getDefaultRegistration(), special() - MultipleServiceRegistry: constructor, all @OverRide methods, getRegistrationClass() - RegistrationMetaData: constructor and all Map @OverRide methods - SimpleAutoServiceRegistration: constructor and all @OverRide methods - SimpleServiceRegistry: all constructors, @OverRide methods, and package-private getInstances() Each JavaDoc includes: - Brief description with {@link} cross-references - Example Usage section with <pre>{@code ...}</pre> blocks - @param, @return tags where applicable Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add comprehensive JavaDoc comments with Example Usage sections using
<pre>{@code ...}</pre> blocks to all non-private methods that were
missing documentation across 10 service registry related files.
Methods documented include @bean factory methods, AOP advices,
lifecycle callbacks, actuator endpoint operations, and protected
template methods.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…g documentation
Add JavaDoc comments to constructors, getters, setters, and other
non-private methods across 7 files in the registry event and fault
tolerance packages. Each JavaDoc follows the project style with brief
descriptions, {@link} cross-references, Example Usage sections using
<pre>{@code}</pre> blocks, and @param/@return tags where applicable.
Files updated:
- RegistrationDeregisteredEvent.java
- RegistrationPreDeregisteredEvent.java
- RegistrationPreRegisteredEvent.java
- RegistrationRegisteredEvent.java
- WeightedRoundRobin.java
- TomcatFaultToleranceAutoConfiguration.java
- TomcatDynamicConfigurationListener.java
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
…nfeign module Add comprehensive JavaDoc comments including brief descriptions, @link cross-references, Example Usage sections with <pre>{@code ...}</pre> blocks, and @param/@return tags to all non-private methods that were missing documentation across 14 files in the openfeign module. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
….attachMetadata Co-authored-by: mercyblitz <533114+mercyblitz@users.noreply.github.com> Agent-Logs-Url: https://github.com/microsphere-projects/microsphere-spring-cloud/sessions/30c49647-70b2-4c4a-9853-02725377f52f
|
Copilot
AI
changed the title
[WIP] Add JavaDoc comments to classes and methods
Add JavaDoc with Example Usage to classes and non-private methods
Mar 21, 2026
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.
Adds JavaDoc documentation with
Example Usagecode blocks to all non-private methods and constructors missing JavaDoc across both modules. Examples are derived from existing test cases.Scope (44 files, ~2350 lines)
ReactiveDiscoveryClientAdapter,UnionDiscoveryClient, auto-configuration classesSimpleServiceRegistry,MultipleServiceRegistry,MultipleRegistration,RegistrationMetaData,InMemoryServiceRegistry, endpoints, aspects, auto-configurationsRegistrationEventand all subclassesWeightedRoundRobin,TomcatDynamicConfigurationListenerAutoRefreshCapability,FeignComponentRegistry, allDecorated*components,CompositedRequestInterceptorServiceInstanceUtils.attachMetadataFormat
Existing JavaDoc is untouched.
@Overridemethods from well-known interfaces use{@inheritDoc}with a brief delegation note.Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
repo.maven.apache.org/usr/lib/jvm/temurin-17-jdk-amd64/bin/java /usr/lib/jvm/temurin-17-jdk-amd64/bin/java --enable-native-access=ALL-UNNAMED -classpath /usr/share/apache-maven-3.9.13/boot/plexus-classworlds-2.9.0.jar -Dclassworlds.conf=/usr/share/apache-maven-3.9.13/bin/m2.conf -Dmaven.home=/usr/share/apache-maven-3.9.13 -Dlibrary.jansi.path=/usr/share/apache-maven-3.9.13/lib/jansi-native -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/microsphere-spring-cloud/microsphere-spring-cloud org.codehaus.plexus.classworlds.launcher.Launcher compile -q(dns block)/usr/lib/jvm/temurin-17-jdk-amd64/bin/java /usr/lib/jvm/temurin-17-jdk-amd64/bin/java --enable-native-access=ALL-UNNAMED -classpath /usr/share/apache-maven-3.9.13/boot/plexus-classworlds-2.9.0.jar -Dclassworlds.conf=/usr/share/apache-maven-3.9.13/bin/m2.conf -Dmaven.home=/usr/share/apache-maven-3.9.13 -Dlibrary.jansi.path=/usr/share/apache-maven-3.9.13/lib/jansi-native -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/microsphere-spring-cloud/microsphere-spring-cloud org.codehaus.plexus.classworlds.launcher.Launcher compile -pl microsphere-spring-cloud-commons -q --get-regexp e/spring/cloud/openfeign/autorefresh/FeignComponentRegistry.java it(dns block)/usr/lib/jvm/temurin-17-jdk-amd64/bin/java /usr/lib/jvm/temurin-17-jdk-amd64/bin/java --enable-native-access=ALL-UNNAMED -classpath /usr/share/apache-maven-3.9.13/boot/plexus-classworlds-2.9.0.jar -Dclassworlds.conf=/usr/share/apache-maven-3.9.13/bin/m2.conf -Dmaven.home=/usr/share/apache-maven-3.9.13 -Dlibrary.jansi.path=/usr/share/apache-maven-3.9.13/lib/jansi-native -Dmaven.multiModuleProjectDirectory=/home/REDACTED/work/microsphere-spring-cloud/microsphere-spring-cloud org.codehaus.plexus.classworlds.launcher.Launcher compile -pl microsphere-spring-cloud-commons conf�� get e/spring/cloud/openfeign/components/DecoratedErrorDecoder.java p/bin/git credential.userngit(dns block)scanning-api.github.com/home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.