aboutsummaryrefslogtreecommitdiff
path: root/common/tags
diff options
context:
space:
mode:
authorPravin Gadakh <prgadakh@in.ibm.com>2016-04-28 15:59:18 -0700
committerDB Tsai <dbt@netflix.com>2016-04-28 15:59:18 -0700
commitdae538a4d7c36191c1feb02ba87ffc624ab960dc (patch)
tree7e40905215019e4bb5f6f927315d71e3c6fdc96f /common/tags
parent78c8aaf849aadbb065730959e7c1b70bb58d69c9 (diff)
downloadspark-dae538a4d7c36191c1feb02ba87ffc624ab960dc.tar.gz
spark-dae538a4d7c36191c1feb02ba87ffc624ab960dc.tar.bz2
spark-dae538a4d7c36191c1feb02ba87ffc624ab960dc.zip
[SPARK-14613][ML] Add @Since into the matrix and vector classes in spark-mllib-local
## What changes were proposed in this pull request? This PR adds `since` tag into the matrix and vector classes in spark-mllib-local. ## How was this patch tested? Scala-style checks passed. Author: Pravin Gadakh <prgadakh@in.ibm.com> Closes #12416 from pravingadakh/SPARK-14613.
Diffstat (limited to 'common/tags')
-rw-r--r--common/tags/pom.xml6
-rw-r--r--common/tags/src/main/scala/org/apache/spark/annotation/Since.scala30
-rw-r--r--common/tags/src/main/scala/org/apache/spark/annotation/package-info.java23
-rw-r--r--common/tags/src/main/scala/org/apache/spark/annotation/package.scala25
-rw-r--r--common/tags/src/test/java/org/apache/spark/tags/DockerTest.java (renamed from common/tags/src/main/java/org/apache/spark/tags/DockerTest.java)0
-rw-r--r--common/tags/src/test/java/org/apache/spark/tags/ExtendedHiveTest.java (renamed from common/tags/src/main/java/org/apache/spark/tags/ExtendedHiveTest.java)0
-rw-r--r--common/tags/src/test/java/org/apache/spark/tags/ExtendedYarnTest.java (renamed from common/tags/src/main/java/org/apache/spark/tags/ExtendedYarnTest.java)0
7 files changed, 81 insertions, 3 deletions
diff --git a/common/tags/pom.xml b/common/tags/pom.xml
index 8e702b4fef..14e94eca93 100644
--- a/common/tags/pom.xml
+++ b/common/tags/pom.xml
@@ -27,12 +27,12 @@
</parent>
<groupId>org.apache.spark</groupId>
- <artifactId>spark-test-tags_2.11</artifactId>
+ <artifactId>spark-tags_2.11</artifactId>
<packaging>jar</packaging>
- <name>Spark Project Test Tags</name>
+ <name>Spark Project Tags</name>
<url>http://spark.apache.org/</url>
<properties>
- <sbt.project.name>test-tags</sbt.project.name>
+ <sbt.project.name>tags</sbt.project.name>
</properties>
<dependencies>
diff --git a/common/tags/src/main/scala/org/apache/spark/annotation/Since.scala b/common/tags/src/main/scala/org/apache/spark/annotation/Since.scala
new file mode 100644
index 0000000000..af483e361e
--- /dev/null
+++ b/common/tags/src/main/scala/org/apache/spark/annotation/Since.scala
@@ -0,0 +1,30 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.spark.annotation
+
+import scala.annotation.StaticAnnotation
+import scala.annotation.meta._
+
+/**
+ * A Scala annotation that specifies the Spark version when a definition was added.
+ * Different from the `@since` tag in JavaDoc, this annotation does not require explicit JavaDoc and
+ * hence works for overridden methods that inherit API documentation directly from parents.
+ * The limitation is that it does not show up in the generated Java API documentation.
+ */
+@param @field @getter @setter @beanGetter @beanSetter
+private[spark] class Since(version: String) extends StaticAnnotation
diff --git a/common/tags/src/main/scala/org/apache/spark/annotation/package-info.java b/common/tags/src/main/scala/org/apache/spark/annotation/package-info.java
new file mode 100644
index 0000000000..9efdccf6b0
--- /dev/null
+++ b/common/tags/src/main/scala/org/apache/spark/annotation/package-info.java
@@ -0,0 +1,23 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Spark annotations to mark an API experimental or intended only for advanced usages by developers.
+ * This package consist of these annotations, which are used project wide and are reflected in
+ * Scala and Java docs.
+ */
+package org.apache.spark.annotation;
diff --git a/common/tags/src/main/scala/org/apache/spark/annotation/package.scala b/common/tags/src/main/scala/org/apache/spark/annotation/package.scala
new file mode 100644
index 0000000000..c3f4026a29
--- /dev/null
+++ b/common/tags/src/main/scala/org/apache/spark/annotation/package.scala
@@ -0,0 +1,25 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.apache.spark
+
+/**
+ * Spark annotations to mark an API experimental or intended only for advanced usages by developers.
+ * This package consist of these annotations, which are used project wide and are reflected in
+ * Scala and Java docs.
+ */
+package object annotation
diff --git a/common/tags/src/main/java/org/apache/spark/tags/DockerTest.java b/common/tags/src/test/java/org/apache/spark/tags/DockerTest.java
index 0fecf3b8f9..0fecf3b8f9 100644
--- a/common/tags/src/main/java/org/apache/spark/tags/DockerTest.java
+++ b/common/tags/src/test/java/org/apache/spark/tags/DockerTest.java
diff --git a/common/tags/src/main/java/org/apache/spark/tags/ExtendedHiveTest.java b/common/tags/src/test/java/org/apache/spark/tags/ExtendedHiveTest.java
index 83279e5e93..83279e5e93 100644
--- a/common/tags/src/main/java/org/apache/spark/tags/ExtendedHiveTest.java
+++ b/common/tags/src/test/java/org/apache/spark/tags/ExtendedHiveTest.java
diff --git a/common/tags/src/main/java/org/apache/spark/tags/ExtendedYarnTest.java b/common/tags/src/test/java/org/apache/spark/tags/ExtendedYarnTest.java
index 108300168e..108300168e 100644
--- a/common/tags/src/main/java/org/apache/spark/tags/ExtendedYarnTest.java
+++ b/common/tags/src/test/java/org/apache/spark/tags/ExtendedYarnTest.java