Exclude javadoc for internal package. (#324)

* Exclude javadoc for internal package add Internal annotation to the internal package.

* Add internal annotation in core_impl, move @Internal in common.

6 files changed, 84 insertions, 0 deletions

diff --git a/all/build.gradle b/all/build.gradle
index 550b924c..e1acc774 100644
--- a/all/build.gradle
+++ b/all/build.gradle
@@ -41,6 +41,7 @@ javadoc {
         source subproject.javadoc.source
         options.links subproject.javadoc.options.links.toArray(new String[0])
     }
+    exclude 'com/google/instrumentation/internal/**'
 }
 
 task jacocoMerge(type: JacocoMerge) {
diff --git a/core/build.gradle b/core/build.gradle
index ec1b7c59..2520ff4c 100644
--- a/core/build.gradle
+++ b/core/build.gradle
@@ -11,3 +11,5 @@ dependencies {
 
     signature "org.codehaus.mojo.signature:java16:+@signature"
 }
+
+javadoc.exclude 'com/google/instrumentation/internal/**'
\ No newline at end of file
diff --git a/core/src/main/java/com/google/instrumentation/common/Internal.java b/core/src/main/java/com/google/instrumentation/common/Internal.java
new file mode 100644
index 00000000..448c5235
--- /dev/null
+++ b/core/src/main/java/com/google/instrumentation/common/Internal.java
@@ -0,0 +1,37 @@
+/*
+ * Copyright 2017, Google Inc.
+ * Licensed 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 com.google.instrumentation.common;
+
+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;
+
+/**
+ * Annotates a program element (class, method, package etc) which is internal to opencensus, not
+ * part of the public API, and should not be used by users of the opencensus library.
+ */
+@Internal
+@Retention(RetentionPolicy.SOURCE)
+@Target({
+    ElementType.ANNOTATION_TYPE,
+    ElementType.CONSTRUCTOR,
+    ElementType.FIELD,
+    ElementType.METHOD,
+    ElementType.PACKAGE,
+    ElementType.TYPE})
+@Documented
+public @interface Internal {
+}
diff --git a/core/src/main/java/com/google/instrumentation/internal/package-info.java b/core/src/main/java/com/google/instrumentation/internal/package-info.java
new file mode 100644
index 00000000..84939705
--- /dev/null
+++ b/core/src/main/java/com/google/instrumentation/internal/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2017, Google Inc.
+ * Licensed 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.
+ */
+
+/**
+ * Interfaces and implementations that are internal to opencensus.
+ *
+ * <p>All the content under this package and its subpackages are considered annotated with {@link
+ * com.google.instrumentation.common.Internal}.
+ */
+@com.google.instrumentation.common.Internal
+package com.google.instrumentation.internal;
diff --git a/core_impl/build.gradle b/core_impl/build.gradle
index 558c0918..9db6338a 100644
--- a/core_impl/build.gradle
+++ b/core_impl/build.gradle
@@ -10,3 +10,5 @@ dependencies {
 
     signature "org.codehaus.mojo.signature:java16:+@signature"
 }
+
+javadoc.exclude 'com/google/instrumentation/internal/**'
\ No newline at end of file
diff --git a/core_impl/src/main/java/com/google/instrumentation/internal/package-info.java b/core_impl/src/main/java/com/google/instrumentation/internal/package-info.java
new file mode 100644
index 00000000..84939705
--- /dev/null
+++ b/core_impl/src/main/java/com/google/instrumentation/internal/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2017, Google Inc.
+ * Licensed 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.
+ */
+
+/**
+ * Interfaces and implementations that are internal to opencensus.
+ *
+ * <p>All the content under this package and its subpackages are considered annotated with {@link
+ * com.google.instrumentation.common.Internal}.
+ */
+@com.google.instrumentation.common.Internal
+package com.google.instrumentation.internal;