Introduce package-info.java in module zookeeper for maven-bundle-plugin

Author: kezhuw

zookeeper/pom.xml

@@ -117,6 +117,14 @@
 
   <build>
     <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <configuration>
+          <skip>true</skip>
+        </configuration>
+      </plugin>
+
       <plugin>
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-dependency-plugin</artifactId>

…java/org/apache/zookeeper/osgi/Osgi.java …a/org/apache/zookeeper/package-info.javazookeeper/src/main/java/org/apache/zookeeper/osgi/Osgi.java renamed to zookeeper/src/main/java/org/apache/zookeeper/package-info.java zookeeper/src/main/java/org/apache/zookeeper/osgi/Osgi.java renamed to zookeeper/src/main/java/org/apache/zookeeper/package-info.java

@@ -16,10 +16,16 @@
  * limitations under the License.
  */
 
-package org.apache.zookeeper.osgi;
-
 /**
- * <b>DON'T USE THIS.</b>
+ * Module to bundle `zookeeper-client`, `zookeeper-server` and others together.
+ *
+ * <p>This module exists for two purposes:
+ * <ol>
+ *     <li>keep compatibility with old zookeeper artifact</li>
+ *     <li>build osgi bundle jar</li>
+ * </ol>
+ *
+ * <p><b>DON'T DELETE THIS FILE.</b>
  *
  * <p>`maven-bundle-plugin` does not include classes if there is no source code. I have no idea why.
  *
@@ -30,8 +36,6 @@
  * <p>We have to include above classes to this bundle without bring other classes from `zookeeper-jute`.
  * `Embed-Dependency` can't handle this as we can not embed `zookeeper-jute` while jar of `zookeeper-server`
  * does not contain those classes. So we have to resort to exclude/include from `Export-Package` as before.
- * But, it does not work if there is no source code, so we have this file for OSGI bundle, and it has to be
- * public otherwise `maven-javadoc-plugin` complains.
+ * But, it does not work if there is no source code, so we have this file for OSGI bundle.
  */
-public class Osgi {
-}
+package org.apache.zookeeper;