Generate Javadoc with APIviz

all/pom.xml

@@ -34,7 +34,57 @@
       <groupId>${project.groupId}</groupId>
       <artifactId>netty-example</artifactId>
       <version>${project.version}</version>
-      <scope>test</scope>
+      <scope>compile</scope>
+      <optional>true</optional>
+    </dependency>
+    <!-- Add optional dependencies explicitly to avoid Javadoc warnings and errors. -->
+    <dependency>
+      <groupId>com.google.protobuf</groupId>
+      <artifactId>protobuf-java</artifactId>
+      <scope>compile</scope>
+      <optional>true</optional>
+    </dependency>
+    <dependency>
+      <groupId>org.jboss.marshalling</groupId>
+      <artifactId>jboss-marshalling</artifactId>
+      <scope>compile</scope>
+      <optional>true</optional>
+    </dependency>
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-api</artifactId>
+      <scope>compile</scope>
+      <optional>true</optional>
+    </dependency>
+    <dependency>
+      <groupId>commons-logging</groupId>
+      <artifactId>commons-logging</artifactId>
+      <scope>compile</scope>
+      <optional>true</optional>
+    </dependency>
+    <dependency>
+      <groupId>org.jboss.logging</groupId>
+      <artifactId>jboss-logging-spi</artifactId>
+      <scope>compile</scope>
+      <optional>true</optional>
+    </dependency>
+    <dependency>
+      <groupId>log4j</groupId>
+      <artifactId>log4j</artifactId>
+      <scope>compile</scope>
+      <optional>true</optional>
+    </dependency>
+    <dependency>
+      <groupId>org.osgi</groupId>
+      <artifactId>org.osgi.core</artifactId>
+      <scope>compile</scope>
+      <optional>true</optional>
+    </dependency>
+    <dependency>
+      <groupId>org.osgi</groupId>
+      <artifactId>org.osgi.compendium</artifactId>
+      <scope>compile</scope>
+      <optional>true</optional>
     </dependency>
   </dependencies>
 
@@ -69,7 +119,7 @@
             <configuration>
               <includes>io/netty/**</includes>
               <excludes>io/netty/example/**</excludes>
-              <outputDirectory>${project.build.directory}/classes</outputDirectory>
+              <outputDirectory>${project.build.outputDirectory}</outputDirectory>
               <overWriteReleases>false</overWriteReleases>
               <overWriteSnapshots>true</overWriteSnapshots>
             </configuration>
@@ -88,6 +138,43 @@
             </goals>
             <configuration>
               <attach>false</attach>
+              <excludePackageNames>*.internal</excludePackageNames>
+              <doclet>org.jboss.apiviz.APIviz</doclet>
+              <docletPath>${project.basedir}/lib/apiviz-1.3.1-jdk7.jar</docletPath>
+              <docfilessubdirs>true</docfilessubdirs>
+              <useStandardDocletOptions>true</useStandardDocletOptions>
+              <outputDirectory>${project.build.directory}/api</outputDirectory>
+              <reportOutputDirectory>${project.build.directory}</reportOutputDirectory>
+              <destDir>api</destDir>
+              <charset>UTF-8</charset>
+              <docencoding>UTF-8</docencoding>
+              <breakiterator>true</breakiterator>
+              <version>false</version>
+              <author>false</author>
+              <keywords>true</keywords>
+              <overview>${basedir}/src/javadoc/overview.html</overview>
+              <doctitle>${parent.project.name} API Reference (${project.version})</doctitle>
+              <windowtitle>${parent.project.name} API Reference (${project.version})</windowtitle>
+              <additionalparam>
+                -link http://docs.oracle.com/javase/7/docs/api/
+                -link http://code.google.com/apis/protocolbuffers/docs/reference/java/
+                -link http://docs.oracle.com/javaee/6/api/
+                -link http://www.osgi.org/javadoc/r4v43/core/
+                -link http://www.slf4j.org/apidocs/
+                -link http://commons.apache.org/logging/commons-logging-1.1.1/apidocs/
+                -link http://logging.apache.org/log4j/1.2/apidocs/
+
+                -group "Low-level data representation" io.netty.buffer*
+                -group "Central interface for all I/O operations" io.netty.channel*
+                -group "Client &amp; Server bootstrapping utilities" io.netty.bootstrap*
+                -group "Reusable I/O event interceptors" io.netty.handler*
+                -group "Miscellaneous" io.netty.logging*:io.netty.util*
+
+                -sourceclasspath ${project.build.outputDirectory}
+                -nopackagediagram
+              </additionalparam>
+              <encoding>UTF-8</encoding>
+              <locale>en_US</locale>
             </configuration>
           </execution>
         </executions>

buffer/src/main/java/io/netty/buffer/ByteBufIndexFinder.java

@@ -24,7 +24,7 @@ package io.netty.buffer;
  * refer to {@link ByteBuf#indexOf(int, int, ByteBufIndexFinder)} and
  * {@link ByteBuf#bytesBefore(int, int, ByteBufIndexFinder)}
  * for more explanation.
- * @apiviz.uses io.netty.buffer.ChannelBuffer
+ * @apiviz.uses io.netty.buffer.ByteBuf
  */
 public interface ByteBufIndexFinder {
 

buffer/src/main/java/io/netty/buffer/ByteBufInputStream.java

@@ -35,7 +35,7 @@ import java.io.InputStream;
  * The endianness of the stream is not always big endian but depends on
  * the endianness of the underlying buffer.
  * @see ByteBufOutputStream
- * @apiviz.uses io.netty.buffer.ChannelBuffer
+ * @apiviz.uses io.netty.buffer.ByteBuf
  */
 public class ByteBufInputStream extends InputStream implements DataInput {
 

buffer/src/main/java/io/netty/buffer/ByteBufOutputStream.java

@@ -31,7 +31,7 @@ import java.io.OutputStream;
  * The endianness of the stream is not always big endian but depends on
  * the endianness of the underlying buffer.
  * @see ByteBufInputStream
- * @apiviz.uses io.netty.buffer.ChannelBuffer
+ * @apiviz.uses io.netty.buffer.ByteBuf
  */
 public class ByteBufOutputStream extends OutputStream implements DataOutput {
 

buffer/src/main/java/io/netty/buffer/Unpooled.java

@@ -77,7 +77,7 @@ import java.util.Queue;
  * of a new buffer type, generation of hex dump and swapping an integer's
  * byte order.
  * @apiviz.landmark
- * @apiviz.has io.netty.buffer.ChannelBuffer oneway - - creates
+ * @apiviz.has io.netty.buffer.ChannelBuf oneway - - creates
  */
 public final class Unpooled {
 

codec/src/main/java/io/netty/handler/codec/DelimiterBasedFrameDecoder.java

@@ -52,7 +52,7 @@ import io.netty.channel.ChannelHandlerContext;
  * | ABC\nDEF |
  * +----------+
  * </pre>
- * @apiviz.uses io.netty.handler.codec.frame.Delimiters - - useful
+ * @apiviz.uses io.netty.handler.codec.Delimiters - - useful
  */
 public class DelimiterBasedFrameDecoder extends ByteToMessageDecoder<Object> {
 

transport/src/main/java/io/netty/channel/ChannelPipeline.java

@@ -202,7 +202,6 @@ import java.util.NoSuchElementException;
  * @apiviz.landmark
  * @apiviz.composedOf io.netty.channel.ChannelHandlerContext
  * @apiviz.owns       io.netty.channel.ChannelHandler
- * @apiviz.uses       io.netty.channel.ChannelSink - - sends events downstream
  */
 public interface ChannelPipeline extends ChannelInboundInvoker, ChannelOutboundInvoker {