Repository: spark Updated Branches: refs/heads/branch-1.5 bdf8dc15d -> 6a7582ea2
[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 <m...@databricks.com> Closes #8131 from mengxr/SPARK-8967. (cherry picked from commit 6f60298b1d7aa97268a42eca1e3b4851a7e88cb5) Signed-off-by: Xiangrui Meng <m...@databricks.com> Project: http://git-wip-us.apache.org/repos/asf/spark/repo Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/6a7582ea Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/6a7582ea Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/6a7582ea Branch: refs/heads/branch-1.5 Commit: 6a7582ea2d232982c3480e7d4ee357ea45d0b303 Parents: bdf8dc1 Author: Xiangrui Meng <m...@databricks.com> Authored: Wed Aug 12 14:28:23 2015 -0700 Committer: Xiangrui Meng <m...@databricks.com> Committed: Wed Aug 12 14:28:34 2015 -0700 ---------------------------------------------------------------------- .../org/apache/spark/annotation/Since.scala | 28 ++++++++++++++++++++ 1 file changed, 28 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/spark/blob/6a7582ea/core/src/main/scala/org/apache/spark/annotation/Since.scala ---------------------------------------------------------------------- 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 0000000..fa59393 --- /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 --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@spark.apache.org For additional commands, e-mail: commits-h...@spark.apache.org
