flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From se...@apache.org
Subject [1/4] flink git commit: [FLINK-5168] Scaladoc annotation link use [[]] instead of {@link}
Date Mon, 28 Nov 2016 13:32:18 GMT
Repository: flink
Updated Branches:
  refs/heads/master 652309c3e -> 354201930


[FLINK-5168] Scaladoc annotation link use [[]] instead of {@link}

This closes #2875


Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/35420193
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/35420193
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/35420193

Branch: refs/heads/master
Commit: 3542019305cfd5b47204b7858a9b19718b0cb6db
Parents: 3d13a05
Author: shijinkui <shijinkui@huawei.com>
Authored: Sat Nov 26 16:14:13 2016 +0800
Committer: Stephan Ewen <sewen@apache.org>
Committed: Mon Nov 28 14:20:08 2016 +0100

----------------------------------------------------------------------
 .../src/main/scala/org/apache/flink/graph/scala/Graph.scala    | 2 +-
 .../flink/graph/scala/test/GellyScalaAPICompletenessTest.scala | 2 +-
 .../runtime/clusterframework/RegisteredMesosWorkerNode.scala   | 2 +-
 .../org/apache/flink/streaming/api/scala/DataStream.scala      | 2 +-
 .../org/apache/flink/streaming/api/scala/SplitStream.scala     | 6 +++---
 .../flink/streaming/api/scala/StreamExecutionEnvironment.scala | 5 ++---
 .../flink/streaming/api/scala/StreamingOperatorsITCase.scala   | 4 ++--
 7 files changed, 11 insertions(+), 12 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flink/blob/35420193/flink-libraries/flink-gelly-scala/src/main/scala/org/apache/flink/graph/scala/Graph.scala
----------------------------------------------------------------------
diff --git a/flink-libraries/flink-gelly-scala/src/main/scala/org/apache/flink/graph/scala/Graph.scala
b/flink-libraries/flink-gelly-scala/src/main/scala/org/apache/flink/graph/scala/Graph.scala
index 4dd9d12..27bc548 100644
--- a/flink-libraries/flink-gelly-scala/src/main/scala/org/apache/flink/graph/scala/Graph.scala
+++ b/flink-libraries/flink-gelly-scala/src/main/scala/org/apache/flink/graph/scala/Graph.scala
@@ -294,7 +294,7 @@ object Graph {
 }
 
 /**
- * Represents a graph consisting of {@link Edge edges} and {@link Vertex vertices}.
+ * Represents a graph consisting of [[Edge]] edges and [[Vertex]] vertices.
  *
  * @param jgraph the underlying java api Graph.
  * @tparam K the key type for vertex and edge identifiers

http://git-wip-us.apache.org/repos/asf/flink/blob/35420193/flink-libraries/flink-gelly-scala/src/test/scala/org/apache/flink/graph/scala/test/GellyScalaAPICompletenessTest.scala
----------------------------------------------------------------------
diff --git a/flink-libraries/flink-gelly-scala/src/test/scala/org/apache/flink/graph/scala/test/GellyScalaAPICompletenessTest.scala
b/flink-libraries/flink-gelly-scala/src/test/scala/org/apache/flink/graph/scala/test/GellyScalaAPICompletenessTest.scala
index d7ab1dd..034bf77 100644
--- a/flink-libraries/flink-gelly-scala/src/test/scala/org/apache/flink/graph/scala/test/GellyScalaAPICompletenessTest.scala
+++ b/flink-libraries/flink-gelly-scala/src/test/scala/org/apache/flink/graph/scala/test/GellyScalaAPICompletenessTest.scala
@@ -26,7 +26,7 @@ import org.junit.Test
 
 /**
  * This checks whether the Gelly Scala API is up to feature parity with the Java API.
- * Implements the {@link ScalaAPICompletenessTest} for Gelly.
+ * Implements the [[ScalaAPICompletenessTestBase]] for Gelly.
  */
 class GellyScalaAPICompletenessTest extends ScalaAPICompletenessTestBase {
 

http://git-wip-us.apache.org/repos/asf/flink/blob/35420193/flink-mesos/src/main/java/org/apache/flink/mesos/runtime/clusterframework/RegisteredMesosWorkerNode.scala
----------------------------------------------------------------------
diff --git a/flink-mesos/src/main/java/org/apache/flink/mesos/runtime/clusterframework/RegisteredMesosWorkerNode.scala
b/flink-mesos/src/main/java/org/apache/flink/mesos/runtime/clusterframework/RegisteredMesosWorkerNode.scala
index 59764ef..7ca388f 100644
--- a/flink-mesos/src/main/java/org/apache/flink/mesos/runtime/clusterframework/RegisteredMesosWorkerNode.scala
+++ b/flink-mesos/src/main/java/org/apache/flink/mesos/runtime/clusterframework/RegisteredMesosWorkerNode.scala
@@ -22,7 +22,7 @@ import org.apache.flink.mesos.runtime.clusterframework.store.MesosWorkerStore
 import org.apache.flink.runtime.clusterframework.types.{ResourceID, ResourceIDRetrievable}
 
 /**
-  * A representation of a registered Mesos task managed by the {@link MesosFlinkResourceManager}.
+  * A representation of a registered Mesos task managed by the [[MesosFlinkResourceManager]].
   */
 case class RegisteredMesosWorkerNode(task: MesosWorkerStore.Worker) extends ResourceIDRetrievable
{
 

http://git-wip-us.apache.org/repos/asf/flink/blob/35420193/flink-streaming-scala/src/main/scala/org/apache/flink/streaming/api/scala/DataStream.scala
----------------------------------------------------------------------
diff --git a/flink-streaming-scala/src/main/scala/org/apache/flink/streaming/api/scala/DataStream.scala
b/flink-streaming-scala/src/main/scala/org/apache/flink/streaming/api/scala/DataStream.scala
index 4fe73e9..dbc91bd 100644
--- a/flink-streaming-scala/src/main/scala/org/apache/flink/streaming/api/scala/DataStream.scala
+++ b/flink-streaming-scala/src/main/scala/org/apache/flink/streaming/api/scala/DataStream.scala
@@ -697,7 +697,7 @@ class DataStream[T](stream: JavaStream[T]) {
    * For the second case and when the watermarks are required to lag behind the maximum
    * timestamp seen so far in the elements of the stream by a fixed amount of time, and this
    * amount is known in advance, use the
-   * {@link org.apache.flink.streaming.api.functions.TimestampExtractorWithFixedAllowedLateness}.
+   * [[org.apache.flink.streaming.api.functions.TimestampExtractorWithFixedAllowedLateness]].
    *
    * For cases where watermarks should be created in an irregular fashion, for example
    * based on certain markers that some element carry, use the

http://git-wip-us.apache.org/repos/asf/flink/blob/35420193/flink-streaming-scala/src/main/scala/org/apache/flink/streaming/api/scala/SplitStream.scala
----------------------------------------------------------------------
diff --git a/flink-streaming-scala/src/main/scala/org/apache/flink/streaming/api/scala/SplitStream.scala
b/flink-streaming-scala/src/main/scala/org/apache/flink/streaming/api/scala/SplitStream.scala
index 0b9ac69..ca4bcc0 100644
--- a/flink-streaming-scala/src/main/scala/org/apache/flink/streaming/api/scala/SplitStream.scala
+++ b/flink-streaming-scala/src/main/scala/org/apache/flink/streaming/api/scala/SplitStream.scala
@@ -23,10 +23,10 @@ import org.apache.flink.streaming.api.datastream.{ SplitStream => SplitJavaStrea
 
 /**
  * The SplitStream represents an operator that has been split using an
- * {@link OutputSelector}. Named outputs can be selected using the
- * {@link #select} function. To apply a transformation on the whole output simply call
+ * [[org.apache.flink.streaming.api.collector.selector.OutputSelector]].
+ * Named outputs can be selected using the [[SplitStream#select()]] function.
+ * To apply a transformation on the whole output simply call
  * the appropriate method on this stream.
- *
  */
 @Public
 class SplitStream[T](javaStream: SplitJavaStream[T]) extends DataStream[T](javaStream){

http://git-wip-us.apache.org/repos/asf/flink/blob/35420193/flink-streaming-scala/src/main/scala/org/apache/flink/streaming/api/scala/StreamExecutionEnvironment.scala
----------------------------------------------------------------------
diff --git a/flink-streaming-scala/src/main/scala/org/apache/flink/streaming/api/scala/StreamExecutionEnvironment.scala
b/flink-streaming-scala/src/main/scala/org/apache/flink/streaming/api/scala/StreamExecutionEnvironment.scala
index 2e432ba..432e8ac 100644
--- a/flink-streaming-scala/src/main/scala/org/apache/flink/streaming/api/scala/StreamExecutionEnvironment.scala
+++ b/flink-streaming-scala/src/main/scala/org/apache/flink/streaming/api/scala/StreamExecutionEnvironment.scala
@@ -502,9 +502,8 @@ class StreamExecutionEnvironment(javaEnv: JavaEnv) {
     *          The files to be excluded from the processing
     * @return The data stream that represents the data read from the given file
     *
-    * @deprecated Use {@link FileInputFormat#setFilesFilter(FilePathFilter)} to set a filter
and
-    *         {@link StreamExecutionEnvironment#readFile(FileInputFormat,
-      *              String, FileProcessingMode, long)}
+    * @deprecated Use [[FileInputFormat#setFilesFilter(FilePathFilter)]] to set a filter
and
+    * [[StreamExecutionEnvironment#readFile(FileInputFormat, String, FileProcessingMode,
long)]]
     */
   @PublicEvolving
   @Deprecated

http://git-wip-us.apache.org/repos/asf/flink/blob/35420193/flink-streaming-scala/src/test/scala/org/apache/flink/streaming/api/scala/StreamingOperatorsITCase.scala
----------------------------------------------------------------------
diff --git a/flink-streaming-scala/src/test/scala/org/apache/flink/streaming/api/scala/StreamingOperatorsITCase.scala
b/flink-streaming-scala/src/test/scala/org/apache/flink/streaming/api/scala/StreamingOperatorsITCase.scala
index c57c29c..e08e0b5 100644
--- a/flink-streaming-scala/src/test/scala/org/apache/flink/streaming/api/scala/StreamingOperatorsITCase.scala
+++ b/flink-streaming-scala/src/test/scala/org/apache/flink/streaming/api/scala/StreamingOperatorsITCase.scala
@@ -58,8 +58,8 @@ class StreamingOperatorsITCase extends ScalaStreamingMultipleProgramsTestBase
{
     * The stream is grouped by the first field. For each group, the resulting stream is folded
by
     * summing up the second tuple field.
     *
-    * This test relies on the hash function used by the {@link DataStream#keyBy}, which is
-    * assumed to be {@link MathUtils#murmurHash}.
+    * This test relies on the hash function used by the [[DataStream#keyBy]], which is
+    * assumed to be [[MathUtils#murmurHash]].
     */
   @Test
   def testGroupedFoldOperator(): Unit = {


Mime
View raw message