From c550d0ac9c63ef10cd0023f2110883f0fcb0cefe Mon Sep 17 00:00:00 2001 From: "lingxiao,wu" <51630311+lingxiao-wu@users.noreply.github.com> Date: Mon, 14 Nov 2022 10:46:35 +0800 Subject: [PATCH] Fix:fix javadoc (#721) Co-authored-by: Haotian Zhang <928016560@qq.com> --- CHANGELOG.md | 1 + .../adapter/PolarisConfigFilePuller.java | 1 + .../configdata/PolarisConfigDataLoader.java | 1 - .../configdata/PolarisConfigDataResource.java | 1 - .../spring/property/PlaceholderHelper.java | 20 +++++++++---------- .../PolarisConfigDataExampleApplication.java | 1 - 6 files changed, 12 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 67ce1b66..65a0431c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,5 +12,6 @@ - [Test:support environment variable metadata test](https://github.com/Tencent/spring-cloud-tencent/pull/698) - [Test: remote deprecated method in test](https://github.com/Tencent/spring-cloud-tencent/pull/706) - [docs:update README.](https://github.com/Tencent/spring-cloud-tencent/pull/718) +- [Fix:fix javadoc.](https://github.com/Tencent/spring-cloud-tencent/pull/721) - [Code optimization & correct comment](https://github.com/Tencent/spring-cloud-tencent/pull/722) - [fix:fix discovery junit.](https://github.com/Tencent/spring-cloud-tencent/pull/725) diff --git a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigFilePuller.java b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigFilePuller.java index 2399ab2f..fc203029 100644 --- a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigFilePuller.java +++ b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/adapter/PolarisConfigFilePuller.java @@ -81,6 +81,7 @@ public final class PolarisConfigFilePuller { * * @param compositePropertySource compositePropertySource * @param activeProfiles activeProfiles + * @param defaultProfiles defaultProfiles * @param serviceName serviceName */ public void initInternalConfigFiles(CompositePropertySource compositePropertySource, String[] activeProfiles, diff --git a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisConfigDataLoader.java b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisConfigDataLoader.java index 300ea1bb..613f0360 100644 --- a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisConfigDataLoader.java +++ b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisConfigDataLoader.java @@ -52,7 +52,6 @@ import static org.springframework.boot.context.config.ConfigData.Option.PROFILE_ * Load {@link ConfigData} via {@link PolarisConfigDataLoader} * * @author wlx - * @date 2022/7/5 11:14 PM */ public class PolarisConfigDataLoader implements ConfigDataLoader { diff --git a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisConfigDataResource.java b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisConfigDataResource.java index c0a33566..ee76e9f1 100644 --- a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisConfigDataResource.java +++ b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/configdata/PolarisConfigDataResource.java @@ -30,7 +30,6 @@ import org.springframework.boot.context.config.Profiles; * A polaris configData resource from which {@link ConfigData} can be loaded. * * @author wlx - * @date 2022/7/5 11:13 PM */ public class PolarisConfigDataResource extends ConfigDataResource { diff --git a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/spring/property/PlaceholderHelper.java b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/spring/property/PlaceholderHelper.java index 8827fa3e..9f8e9b76 100644 --- a/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/spring/property/PlaceholderHelper.java +++ b/spring-cloud-starter-tencent-polaris-config/src/main/java/com/tencent/cloud/polaris/config/spring/property/PlaceholderHelper.java @@ -52,7 +52,7 @@ public class PlaceholderHelper { * @param beanFactory beanFactory * @param beanName beanName * @param placeholder placeholder - * @return "${somePropertyValue}" -> "the actual property value" + * @return "${somePropertyValue}" -> "the actual property value" */ public Object resolvePropertyValue(ConfigurableBeanFactory beanFactory, String beanName, String placeholder) { // resolve string value @@ -77,16 +77,16 @@ public class PlaceholderHelper { } /** - * * @param propertyString propertyString - * @return - * Extract keys from placeholder, e.g. - *
  • ${some.key} => "some.key"
    • - *
  • ${some.key:${some.other.key:100}} => "some.key", "some.other.key"
    • - *
  • ${${some.key}} => "some.key"
    • - *
  • ${${some.key:other.key}} => "some.key"
    • - *
  • ${${some.key}:${another.key}} => "some.key", "another.key"
    • - *
  • #{new java.text.SimpleDateFormat('${some.key}').parse('${another.key}')} => "some.key", "another.key"
    • + * @return Extract keys from placeholder, e.g. + * */ public Set extractPlaceholderKeys(String propertyString) { Set placeholderKeys = Sets.newHashSet(); diff --git a/spring-cloud-tencent-examples/polaris-config-data-example/src/main/java/com/tencent/cloud/polaris/config/example/PolarisConfigDataExampleApplication.java b/spring-cloud-tencent-examples/polaris-config-data-example/src/main/java/com/tencent/cloud/polaris/config/example/PolarisConfigDataExampleApplication.java index 78eec0f1..f2183bd8 100644 --- a/spring-cloud-tencent-examples/polaris-config-data-example/src/main/java/com/tencent/cloud/polaris/config/example/PolarisConfigDataExampleApplication.java +++ b/spring-cloud-tencent-examples/polaris-config-data-example/src/main/java/com/tencent/cloud/polaris/config/example/PolarisConfigDataExampleApplication.java @@ -5,7 +5,6 @@ import org.springframework.boot.autoconfigure.SpringBootApplication; /** * @author wlx - * @date 2022/7/6 9:15 PM */ @SpringBootApplication public class PolarisConfigDataExampleApplication {