diff options
| author | Xiangrui Meng <meng@databricks.com> | 2015-08-12 14:28:23 -0700 |
|---|---|---|
| committer | Xiangrui Meng <meng@databricks.com> | 2015-08-12 14:28:23 -0700 |
| commit | 6f60298b1d7aa97268a42eca1e3b4851a7e88cb5 (patch) | |
| tree | 8bf347f4c7c9dc3cb6755c4809a0dfbc3a36bd20 /core | |
| parent | 551def5d6972440365bd7436d484a67138d9a8f3 (diff) | |
| download | spark-6f60298b1d7aa97268a42eca1e3b4851a7e88cb5.tar.gz spark-6f60298b1d7aa97268a42eca1e3b4851a7e88cb5.tar.bz2 spark-6f60298b1d7aa97268a42eca1e3b4851a7e88cb5.zip | |
[SPARK-8967] [DOC] add Since annotation
Add `Since` as a Scala annotation. The benefit is that we can use it without having explicit JavaDoc. This is useful for inherited methods. The limitation is that is doesn't show up in the generated Java API documentation. This might be fixed by modifying genjavadoc. I think we could leave it as a TODO.
This is how the generated Scala doc looks:
`since` JavaDoc tag:
`Since` annotation:
rxin
Author: Xiangrui Meng <meng@databricks.com>
Closes #8131 from mengxr/SPARK-8967.
Diffstat (limited to 'core')
| -rw-r--r-- | core/src/main/scala/org/apache/spark/annotation/Since.scala | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/core/src/main/scala/org/apache/spark/annotation/Since.scala b/core/src/main/scala/org/apache/spark/annotation/Since.scala new file mode 100644 index 0000000000..fa59393c22 --- /dev/null +++ b/core/src/main/scala/org/apache/spark/annotation/Since.scala @@ -0,0 +1,28 @@ +/* + * 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 + +/** + * 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. + */ +private[spark] class Since(version: String) extends StaticAnnotation |