flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From se...@apache.org
Subject [1/6] flink git commit: [hotfix] Fixes to flink-annotations JavaDocs
Date Wed, 17 Feb 2016 14:18:01 GMT
Repository: flink
Updated Branches:
  refs/heads/master 50a166df3 -> a4e8fcbe9


[hotfix] Fixes to flink-annotations JavaDocs


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

Branch: refs/heads/master
Commit: 97d1f4a1c9255af86c68e63dbe1712ace9d7bb01
Parents: 50a166d
Author: Stephan Ewen <sewen@apache.org>
Authored: Tue Feb 16 15:05:50 2016 +0100
Committer: Stephan Ewen <sewen@apache.org>
Committed: Wed Feb 17 15:09:12 2016 +0100

----------------------------------------------------------------------
 .../src/main/java/org/apache/flink/annotation/Internal.java    | 2 +-
 .../src/main/java/org/apache/flink/annotation/Public.java      | 6 +++---
 .../main/java/org/apache/flink/annotation/PublicEvolving.java  | 6 +++---
 3 files changed, 7 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flink/blob/97d1f4a1/flink-annotations/src/main/java/org/apache/flink/annotation/Internal.java
----------------------------------------------------------------------
diff --git a/flink-annotations/src/main/java/org/apache/flink/annotation/Internal.java b/flink-annotations/src/main/java/org/apache/flink/annotation/Internal.java
index 9de1aba..dd9f080 100644
--- a/flink-annotations/src/main/java/org/apache/flink/annotation/Internal.java
+++ b/flink-annotations/src/main/java/org/apache/flink/annotation/Internal.java
@@ -25,7 +25,7 @@ import java.lang.annotation.Target;
 /**
  * Interface to mark methods within stable, public APIs as an internal developer API.
  *
- * Developer APIs are stable but internal to Flink and might change across releases.
+ * <p>Developer APIs are stable but internal to Flink and might change across releases.
  */
 @Documented
 @Target({ ElementType.TYPE, ElementType.METHOD, ElementType.CONSTRUCTOR })

http://git-wip-us.apache.org/repos/asf/flink/blob/97d1f4a1/flink-annotations/src/main/java/org/apache/flink/annotation/Public.java
----------------------------------------------------------------------
diff --git a/flink-annotations/src/main/java/org/apache/flink/annotation/Public.java b/flink-annotations/src/main/java/org/apache/flink/annotation/Public.java
index e545eef..d891a0a 100644
--- a/flink-annotations/src/main/java/org/apache/flink/annotation/Public.java
+++ b/flink-annotations/src/main/java/org/apache/flink/annotation/Public.java
@@ -25,10 +25,10 @@ import java.lang.annotation.Target;
 /**
  * Annotation for marking classes as public, stable interfaces.
  *
- * Classes, methods and fields with this annotation are stable across minor releases (1.0,
1.1, 1.2). In other words,
- * applications using @PublicInterface annotated classes will compile against newer versions
of the same major release.
+ * <p>Classes, methods and fields with this annotation are stable across minor releases
(1.0, 1.1, 1.2). In other words,
+ * applications using @Public annotated classes will compile against newer versions of the
same major release.
  *
- * Only major releases (1.0, 2.0, 3.0) can break interfaces with this annotation.
+ * <p>Only major releases (1.0, 2.0, 3.0) can break interfaces with this annotation.
  */
 @Documented
 @Target(ElementType.TYPE)

http://git-wip-us.apache.org/repos/asf/flink/blob/97d1f4a1/flink-annotations/src/main/java/org/apache/flink/annotation/PublicEvolving.java
----------------------------------------------------------------------
diff --git a/flink-annotations/src/main/java/org/apache/flink/annotation/PublicEvolving.java
b/flink-annotations/src/main/java/org/apache/flink/annotation/PublicEvolving.java
index 289d891..0c093a2 100644
--- a/flink-annotations/src/main/java/org/apache/flink/annotation/PublicEvolving.java
+++ b/flink-annotations/src/main/java/org/apache/flink/annotation/PublicEvolving.java
@@ -23,13 +23,13 @@ import java.lang.annotation.ElementType;
 import java.lang.annotation.Target;
 
 /**
- * Annotation to mark classes and methods for public use but with evolving interfaces.
+ * Annotation to mark classes and methods for public use, but with evolving interfaces.
  *
- * Classes and methods with this annotation are intended for public use and have stable behavior.
+ * <p>Classes and methods with this annotation are intended for public use and have
stable behavior.
  * However, their interfaces and signatures are not considered to be stable and might be
changed
  * across versions.
  *
- * This annotation also excludes methods and classes with evolving interfaces / signatures
+ * <p>This annotation also excludes methods and classes with evolving interfaces /
signatures
  * within classes annotated with {@link Public}.
  *
  */


Mime
View raw message