summaryrefslogtreecommitdiffstats
path: root/annotations/src/main/java/com/yahoo/api/annotations/PublicApi.java
diff options
context:
space:
mode:
Diffstat (limited to 'annotations/src/main/java/com/yahoo/api/annotations/PublicApi.java')
-rw-r--r--annotations/src/main/java/com/yahoo/api/annotations/PublicApi.java23
1 files changed, 23 insertions, 0 deletions
diff --git a/annotations/src/main/java/com/yahoo/api/annotations/PublicApi.java b/annotations/src/main/java/com/yahoo/api/annotations/PublicApi.java
new file mode 100644
index 00000000000..7bb250a8b73
--- /dev/null
+++ b/annotations/src/main/java/com/yahoo/api/annotations/PublicApi.java
@@ -0,0 +1,23 @@
+// Copyright 2016 Yahoo Inc. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
+package com.yahoo.api.annotations;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * For annotating packages that should be part of the public API.
+ *
+ * Must be placed in a file called package-info.java in the
+ * package that is to be public.
+ * @author tonytv
+ * @author gjoranv
+ * @since 5.1.5
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.PACKAGE)
+@Documented
+public @interface PublicApi {
+}