resolve javadoc error. (#344)

* resolve javadoc error. * add maven-war-plugin
nacos-group · Jun 14, 2024 · 4b106fb · 4b106fb
1 parent 9b61ef6
commit 4b106fb
Show file tree

Hide file tree

Showing 9 changed files with 27 additions and 13 deletions.
diff --git a/nacos-spring-context-aot/pom.xml b/nacos-spring-context-aot/pom.xml
@@ -30,7 +30,6 @@
         <dependency>
             <groupId>com.alibaba.nacos</groupId>
             <artifactId>nacos-spring-context</artifactId>
-            <version>${revision}</version>
             <optional>true</optional>
         </dependency>
     </dependencies>

diff --git a/...libaba/nacos/spring/context/annotation/config/SpringValueAnnotationBeanPostProcessor.java b/...libaba/nacos/spring/context/annotation/config/SpringValueAnnotationBeanPostProcessor.java
@@ -52,7 +52,6 @@
 /**
  * @author wuhaoqiang
  * @since 1.1.2
- * @desc: spring @Value Processor
  **/
 public class SpringValueAnnotationBeanPostProcessor
         extends AbstractAnnotationBeanPostProcessor implements BeanFactoryAware,

diff --git a/...main/java/com/alibaba/nacos/spring/context/event/config/EventPublishingConfigService.java b/...main/java/com/alibaba/nacos/spring/context/event/config/EventPublishingConfigService.java
@@ -174,7 +174,7 @@ public Properties getProperties() {
 
 	/**
 	 * Destroy lifecycle method to invoke {@link #shutDown()}
-	 * @throws Exception
+	 * @throws Exception throw exception
 	 * @since 1.0.0
 	 */
 	@Override

diff --git a/nacos-spring-context/src/main/java/com/alibaba/nacos/spring/enums/FileTypeEnum.java b/nacos-spring-context/src/main/java/com/alibaba/nacos/spring/enums/FileTypeEnum.java
@@ -87,7 +87,7 @@ public String getFileType() {
      * Get the corresponding FileTypeEnum by file extension or fileType. If not found FileTypeEnum.TEXT is returned
      *
      * @param extOrFileType file extension or fileType
-     * @return
+     * @return return {@link FileTypeEnum}
      */
     public static FileTypeEnum getFileTypeEnumByFileExtensionOrFileType(String extOrFileType) {
         if (StringUtils.isNotBlank(extOrFileType)) {

diff --git a/nacos-spring-context/src/main/java/com/alibaba/nacos/spring/util/NacosUtils.java b/nacos-spring-context/src/main/java/com/alibaba/nacos/spring/util/NacosUtils.java
@@ -532,6 +532,7 @@ public static Map<String, Object> toProperties(String dataId, String group,
 	 * @param group config group
 	 * @param text config context
 	 * @param type config type
+	 * @return  map format of result
 	 */
 	public static Map<String, Object> toProperties(String dataId, String group,
 			String text, String type) {

diff --git a/nacos-spring-context/src/main/java/com/alibaba/nacos/spring/util/PlaceholderHelper.java b/nacos-spring-context/src/main/java/com/alibaba/nacos/spring/util/PlaceholderHelper.java
@@ -20,12 +20,12 @@ public class PlaceholderHelper {
 
     /**
      * find keys from placeholder
-     * ${key} -> "key"
-     * xxx${key}yyy -> "key"
-     * ${key:${key2:1}} -> "key", "key2"
-     * ${${key}} -> "key"
-     * ${${key:100}} -> "key"
-     * ${${key}:${key2}} -> "key", "key2"
+     * ${key} - "key"
+     * xxx${key}yyy - "key"
+     * ${key:${key2:1}} - "key", "key2"
+     * ${${key}} - "key"
+     * ${${key:100}} - "key"
+     * ${${key}:${key2}} - "key", "key2"
      * @param propertyString ${key}
      * @return key
      */

diff --git a/nacos-spring-context/src/main/java/com/alibaba/nacos/spring/util/aot/NativeDetector.java b/nacos-spring-context/src/main/java/com/alibaba/nacos/spring/util/aot/NativeDetector.java
@@ -25,7 +25,7 @@ public abstract class NativeDetector {
 	private static final boolean imageCode = (System.getProperty("org.graalvm.nativeimage.imagecode") != null);
 
 	/**
-	 * Returns {@code true} if invoked in the context of image building or during image runtime, else {@code false}.
+	 * @return Returns {@code true} if invoked in the context of image building or during image runtime, else {@code false}.
 	 */
 	public static boolean inNativeImage() {
 		return imageCode;

diff --git a/nacos-spring-samples/nacos-spring-webmvc-sample/pom.xml b/nacos-spring-samples/nacos-spring-webmvc-sample/pom.xml
@@ -39,12 +39,10 @@
         <dependency>
             <groupId>${project.groupId}</groupId>
             <artifactId>nacos-spring-context</artifactId>
-            <version>${project.version}</version>
         </dependency>
         <dependency>
             <groupId>${project.groupId}</groupId>
             <artifactId>nacos-embedded-webserver</artifactId>
-            <version>${project.version}</version>
         </dependency>
     </dependencies>
 

diff --git a/pom.xml b/pom.xml
@@ -204,6 +204,18 @@
                 <artifactId>guava</artifactId>
                 <version>${guava.version}</version>
             </dependency>
+
+            <dependency>
+                <groupId>${project.groupId}</groupId>
+                <artifactId>nacos-spring-context</artifactId>
+                <version>${revision}</version>
+            </dependency>
+            <dependency>
+                <groupId>${project.groupId}</groupId>
+                <artifactId>nacos-embedded-webserver</artifactId>
+                <version>${revision}</version>
+            </dependency>
+
         </dependencies>
     </dependencyManagement>
 
@@ -386,6 +398,11 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-war-plugin</artifactId>
+                <version>3.4.0</version>
+            </plugin>
         </plugins>
     </build>