Fix javadoc error and run javadoc in CI (#10516)

Author: kezhenxu94

.github/workflows/skywalking.yaml

@@ -163,7 +163,6 @@ jobs:
         run: |
           ./mvnw clean install -B -q \
             -Dmaven.test.skip \
-            -Dmaven.javadoc.skip \
             -Dcheckstyle.skip
       - uses: actions/upload-artifact@v3
         name: Upload distribution tar

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/CoreModuleConfig.java

@@ -112,7 +112,7 @@ public class CoreModuleConfig extends ModuleConfig {
      * load for memory, network of OAP and storage.
      *
      * But, being activated, user could see the name in the storage entities, which make users easier to use 3rd party
-     * tool, such as Kibana->ES, to query the data by themselves.
+     * tool, such as Kibana->ES, to query the data by themselves.
      */
     private boolean activeExtraModelColumns = false;
     /**

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/analysis/Layer.java

@@ -124,7 +124,7 @@ public enum Layer {
     MYSQL(18, true),
 
     /**
-     * Cache conjectured by client side plugin(eg. skywalking-java -> JedisPlugin LettucePlugin)
+     * Cache conjectured by client side plugin(eg. skywalking-java -> JedisPlugin LettucePlugin)
      */
     VIRTUAL_CACHE(19, false),
 

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/storage/annotation/BanyanDB.java

@@ -65,7 +65,6 @@
      * <p>
      * Only work with {@link Column}
      *
-     * @return non-negative if this column be used for sharding. -1 means not as a sharding key
      * @since 9.3.0 Rename as SeriesID.
      * @since 9.1.0 created as a new annotation.
      * @since 9.0.0 added in {@link Column}
@@ -84,7 +83,7 @@
          * considering OAP finds services by "layer", the "layer" 's index should be 0 to
          * trigger a prefix-scanning.
          *
-         * @return index, from zero.
+         * @return non-negative if this column be used for sharding. -1 means not as a sharding key
          */
         int index() default -1;
     }
@@ -158,7 +157,7 @@ enum IndexType {
 
     /**
      * StoreIDTag indicates a metric store its ID as a tag for searching.
-     * @Since 9.4.0
+     * @since 9.4.0
      */
     @Target({ElementType.TYPE})
     @Retention(RetentionPolicy.RUNTIME)

oap-server/server-core/src/main/java/org/apache/skywalking/oap/server/core/storage/annotation/SQLDatabase.java

@@ -59,15 +59,18 @@
      * Support create additional tables from a model.<br>
      * <p>
      * Notice:
+     * <ul>
      * <li>This feature only support `Record` type.
      * <li>An additional table only supports one list-type field.
      * <li>Create `MultiColumnsIndex` on the additional table only when it contains all need columns.
+     * </ul>
      * <p>
      * The typical use is: when need to storage a `List` field, we can transform it to another table as row set.<br>
      * For example in SegmentRecord#tags create an additional table:
-     * <pre>{@code
-     *     @SQLDatabase.AdditionalEntity(additionalTables = {ADDITIONAL_TAG_TABLE})
-     *     private List<String> tags;}</pre>
+     * <pre>
+     *     {@code @SQLDatabase.AdditionalEntity(additionalTables = {ADDITIONAL_TAG_TABLE})}
+     *     {@code private List<String> tags;}
+     * </pre>
      * <p>
      * In H2TraceQueryDAO#queryBasicTraces query tags as condition from this additional table, could build sql like this:
      * <pre>{@code
@@ -95,18 +98,19 @@
      *         }
      *         }</pre>
      * <p>
+     * <ul>
      * <li>If no tags condition, only query segment table, the SQL should be: select
      * column1, column2 ... from segment where 1=1 and colunm1=xx ...
      *
-     *<li> If 1 tag condition, query both segment and segment_tag tables, the SQL should be: select column1, column2 ...
+     * <li> If 1 tag condition, query both segment and segment_tag tables, the SQL should be: select column1, column2 ...
      * from segment inner join segment_tag segment_tag0 on segment.id=segment_tag0.id where 1=1 and colunm1=xx ... and
      * segment_tag0=tagString0
      *
-     *<li> If 2 or more tags condition, query both segment and segment_tag tables, the SQL should be: select column1,
+     * <li> If 2 or more tags condition, query both segment and segment_tag tables, the SQL should be: select column1,
      * column2 ... from segment inner join segment_tag segment_tag0 on segment.id=segment_tag0.id inner join segment_tag
      * segment_tag1 on segment.id=segment_tag1.id ... where 1=1 and colunm1=xx ... and segment_tag0=tagString0 and
      * segment_tag1=tagString1 ...
-     *
+     * </ul>
      */
     @Target({ElementType.FIELD})
     @Retention(RetentionPolicy.RUNTIME)

oap-server/server-storage-plugin/storage-elasticsearch-plugin/src/main/java/org/apache/skywalking/oap/server/storage/plugin/elasticsearch/StorageModuleElasticsearchConfig.java

@@ -145,7 +145,7 @@ public class StorageModuleElasticsearchConfig extends ModuleConfig {
 
     /**
      * The number of threads for the underlying HTTP client to perform socket I/O.
-     * If the value is <= 0, the number of available processors will be used.
+     * If the value is {@code <= 0}, the number of available processors will be used.
      */
     private int numHttpClientThread;
 

pom.xml

@@ -473,6 +473,35 @@
                     </execution>
                 </executions>
             </plugin>
+
+            <plugin>
+                <groupId>org.projectlombok</groupId>
+                <artifactId>lombok-maven-plugin</artifactId>
+                <version>1.18.20.0</version>
+                <configuration>
+                    <sourceDirectory>${project.basedir}/src/main/java</sourceDirectory>
+                </configuration>
+                <executions>
+                    <execution>
+                        <phase>generate-sources</phase>
+                        <goals>
+                            <goal>delombok</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <configuration>
+                    <sourcepath>
+                        ${project.build.directory}/generated-sources/delombok;
+                        ${project.build.directory}/generated-sources/protobuf/java;
+                        ${project.build.directory}/generated-sources/protobuf/grpc-java;
+                        ${project.build.directory}/generated-sources/antlr4;;
+                    </sourcepath>
+                </configuration>
+            </plugin>
         </plugins>
     </build>
 </project>