flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From aljos...@apache.org
Subject [60/60] git commit: [scala] Add package documentation for package api.scala
Date Mon, 22 Sep 2014 12:29:42 GMT
[scala] Add package documentation for package api.scala


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

Branch: refs/heads/master
Commit: ec562ceb57364a75437e5a93c32aa061f94708d8
Parents: 0c79538
Author: Aljoscha Krettek <aljoscha.krettek@gmail.com>
Authored: Sat Sep 20 18:00:23 2014 +0200
Committer: Aljoscha Krettek <aljoscha.krettek@gmail.com>
Committed: Mon Sep 22 13:43:03 2014 +0200

----------------------------------------------------------------------
 .../main/scala/org/apache/flink/api/scala/package.scala | 12 ++++++++++++
 1 file changed, 12 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-flink/blob/ec562ceb/flink-scala/src/main/scala/org/apache/flink/api/scala/package.scala
----------------------------------------------------------------------
diff --git a/flink-scala/src/main/scala/org/apache/flink/api/scala/package.scala b/flink-scala/src/main/scala/org/apache/flink/api/scala/package.scala
index 8bb69f9..998d579 100644
--- a/flink-scala/src/main/scala/org/apache/flink/api/scala/package.scala
+++ b/flink-scala/src/main/scala/org/apache/flink/api/scala/package.scala
@@ -24,6 +24,18 @@ import org.apache.flink.types.TypeInformation
 import org.apache.flink.api.scala.typeutils.{CaseClassTypeInfo, TypeUtils}
 import org.apache.flink.api.java.{DataSet => JavaDataSet}
 
+/**
+ * The Flink Scala API. [[org.apache.flink.api.scala.ExecutionEnvironment]] is the starting-point
+ * of any Flink program. It can be used to read from local files, HDFS, or other sources.
+ * [[org.apache.flink.api.scala.DataSet]] is the main abstraction of data in Flink. It provides
+ * operations that create new DataSets via transformations.
+ * [[org.apache.flink.api.scala.GroupedDataSet]] provides operations on grouped data that
results
+ * from [[org.apache.flink.api.scala.DataSet.groupBy()]].
+ *
+ * Use [[org.apache.flink.api.scala.ExecutionEnvironment.getExecutionEnvironment]] to obtain
+ * an execution environment. This will either create a local environment or a remote environment,
+ * depending on the context where your program is executing.
+ */
 package object scala {
   // We have this here so that we always have generated TypeInformationS when
   // using the Scala API


Mime
View raw message