support scala doc (vesoft-inc#140)

slimpig · Aug 25, 2020 · 2792773 · 2792773
1 parent 376f160
commit 2792773
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 18 deletions.
diff --git a/tools/exchange/pom.xml b/tools/exchange/pom.xml
@@ -130,23 +130,33 @@
                 </executions>
             </plugin>
             <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-javadoc-plugin</artifactId>
-                <version>3.2.0</version>
+                <groupId>net.alchim31.maven</groupId>
+                <artifactId>scala-maven-plugin</artifactId>
+                <version>4.4.0</version>
                 <executions>
+                    <execution>
+                        <id>Scaladoc</id>
+                        <goals>
+                            <goal>doc</goal>
+                        </goals>
+                        <phase>prepare-package</phase>
+                        <configuration>
+                            <args>
+                                <arg>-nobootcp</arg>
+                                <arg>-no-link-warnings</arg>
+                            </args>
+                        </configuration>
+                    </execution>
                     <execution>
                         <id>attach-javadocs</id>
-                        <phase>package</phase>
                         <goals>
-                            <goal>jar</goal>
+                            <goal>doc-jar</goal>
                         </goals>
                         <configuration>
-                            <encoding>UTF-8</encoding>
-                            <charset>UTF-8</charset>
-                            <additionalOptions>
-                                <additionalparam>-source 8</additionalparam>
-                                <additionalOption>-Xdoclint:none</additionalOption>
-                            </additionalOptions>
+                            <args>
+                                <arg>-nobootcp</arg>
+                                <arg>-no-link-warnings</arg>
+                            </args>
                         </configuration>
                     </execution>
                 </executions>
@@ -253,6 +263,10 @@
                     <artifactId>commons-configuration</artifactId>
                     <groupId>commons-configuration</groupId>
                 </exclusion>
+                <exclusion>
+                    <artifactId>jul-to-slf4j</artifactId>
+                    <groupId>org.slf4j</groupId>
+                </exclusion>
             </exclusions>
         </dependency>
         <dependency>

diff --git a/tools/exchange/src/main/scala/com/vesoft/nebula/tools/importer/reader/ServerBaseReader.scala b/tools/exchange/src/main/scala/com/vesoft/nebula/tools/importer/reader/ServerBaseReader.scala
@@ -29,8 +29,8 @@ import org.neo4j.spark.utils.Neo4jSessionAwareIterator
 import scala.collection.JavaConverters._
 
 /**
-  * @{link ServerBaseReader} is the abstract class of
-  *        It include a spark session and a sentence which will sent to service.
+  * ServerBaseReader is the abstract class of
+  * It include a spark session and a sentence which will sent to service.
   * @param session
   * @param sentence
   */
@@ -43,8 +43,8 @@ abstract class ServerBaseReader(override val session: SparkSession, sentence: St
 }
 
 /**
-  * @{link HiveReader} extends the @{link ServerBaseReader}.
-  *        The HiveReader reading data from Apache Hive via sentence.
+  * HiveReader extends the @{link ServerBaseReader}.
+  * The HiveReader reading data from Apache Hive via sentence.
   * @param session
   * @param sentence
   */
@@ -56,7 +56,7 @@ class HiveReader(override val session: SparkSession, sentence: String)
 }
 
 /**
-  * The @{link MySQLReader} extends the @{link ServerBaseReader}.
+  * The MySQLReader extends the ServerBaseReader.
   * The MySQLReader reading data from MySQL via sentence.
   *
   * @param session
@@ -90,7 +90,7 @@ class MySQLReader(override val session: SparkSession,
 }
 
 /**
-  * @{link Neo4JReader} extends the @{link ServerBaseReader}
+  * Neo4JReader extends the ServerBaseReader
   * @param session
   * @param config
   */
@@ -193,7 +193,7 @@ class Neo4JReader(override val session: SparkSession, config: Neo4JSourceConfigE
 }
 
 /**
-  * @{link JanusGraphReader} extends the @{link ServerBaseReader}
+  * JanusGraphReader extends the link ServerBaseReader
   * @param session
   * @param sentence
   * @param isEdge