From 279277331b7332d522d8f49adc1894d0d388727a Mon Sep 17 00:00:00 2001 From: yaphet Date: Tue, 25 Aug 2020 17:39:52 +0800 Subject: [PATCH] support scala doc (#140) --- tools/exchange/pom.xml | 36 +++++++++++++------ .../importer/reader/ServerBaseReader.scala | 14 ++++---- 2 files changed, 32 insertions(+), 18 deletions(-) diff --git a/tools/exchange/pom.xml b/tools/exchange/pom.xml index 29add67a4..41382e3ab 100644 --- a/tools/exchange/pom.xml +++ b/tools/exchange/pom.xml @@ -130,23 +130,33 @@ - org.apache.maven.plugins - maven-javadoc-plugin - 3.2.0 + net.alchim31.maven + scala-maven-plugin + 4.4.0 + + Scaladoc + + doc + + prepare-package + + + -nobootcp + -no-link-warnings + + + attach-javadocs - package - jar + doc-jar - UTF-8 - UTF-8 - - -source 8 - -Xdoclint:none - + + -nobootcp + -no-link-warnings + @@ -253,6 +263,10 @@ commons-configuration commons-configuration + + jul-to-slf4j + org.slf4j + 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 index 1b6b2c9d2..111d534c9 100644 --- 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