diff options
author | Pravin Gadakh <prgadakh@in.ibm.com> | 2016-04-28 15:59:18 -0700 |
---|---|---|
committer | DB Tsai <dbt@netflix.com> | 2016-04-28 15:59:18 -0700 |
commit | dae538a4d7c36191c1feb02ba87ffc624ab960dc (patch) | |
tree | 7e40905215019e4bb5f6f927315d71e3c6fdc96f /common/tags/src/main | |
parent | 78c8aaf849aadbb065730959e7c1b70bb58d69c9 (diff) | |
download | spark-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/src/main')
-rw-r--r-- | common/tags/src/main/scala/org/apache/spark/annotation/Since.scala (renamed from common/tags/src/main/java/org/apache/spark/tags/ExtendedYarnTest.java) | 19 | ||||
-rw-r--r-- | common/tags/src/main/scala/org/apache/spark/annotation/package-info.java (renamed from common/tags/src/main/java/org/apache/spark/tags/DockerTest.java) | 15 | ||||
-rw-r--r-- | common/tags/src/main/scala/org/apache/spark/annotation/package.scala (renamed from common/tags/src/main/java/org/apache/spark/tags/ExtendedHiveTest.java) | 16 |
3 files changed, 24 insertions, 26 deletions
diff --git a/common/tags/src/main/java/org/apache/spark/tags/ExtendedYarnTest.java b/common/tags/src/main/scala/org/apache/spark/annotation/Since.scala index 108300168e..af483e361e 100644 --- a/common/tags/src/main/java/org/apache/spark/tags/ExtendedYarnTest.java +++ b/common/tags/src/main/scala/org/apache/spark/annotation/Since.scala @@ -15,13 +15,16 @@ * limitations under the License. */ -package org.apache.spark.tags; +package org.apache.spark.annotation -import java.lang.annotation.*; +import scala.annotation.StaticAnnotation +import scala.annotation.meta._ -import org.scalatest.TagAnnotation; - -@TagAnnotation -@Retention(RetentionPolicy.RUNTIME) -@Target({ElementType.METHOD, ElementType.TYPE}) -public @interface ExtendedYarnTest { } +/** + * 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/java/org/apache/spark/tags/DockerTest.java b/common/tags/src/main/scala/org/apache/spark/annotation/package-info.java index 0fecf3b8f9..9efdccf6b0 100644 --- a/common/tags/src/main/java/org/apache/spark/tags/DockerTest.java +++ b/common/tags/src/main/scala/org/apache/spark/annotation/package-info.java @@ -15,12 +15,9 @@ * limitations under the License. */ -package org.apache.spark.tags; - -import java.lang.annotation.*; -import org.scalatest.TagAnnotation; - -@TagAnnotation -@Retention(RetentionPolicy.RUNTIME) -@Target({ElementType.METHOD, ElementType.TYPE}) -public @interface DockerTest { } +/** + * 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/java/org/apache/spark/tags/ExtendedHiveTest.java b/common/tags/src/main/scala/org/apache/spark/annotation/package.scala index 83279e5e93..c3f4026a29 100644 --- a/common/tags/src/main/java/org/apache/spark/tags/ExtendedHiveTest.java +++ b/common/tags/src/main/scala/org/apache/spark/annotation/package.scala @@ -15,13 +15,11 @@ * limitations under the License. */ -package org.apache.spark.tags; +package org.apache.spark -import java.lang.annotation.*; - -import org.scalatest.TagAnnotation; - -@TagAnnotation -@Retention(RetentionPolicy.RUNTIME) -@Target({ElementType.METHOD, ElementType.TYPE}) -public @interface ExtendedHiveTest { } +/** + * 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 |