From 4aacf50758fd5cf3b8c04f4f559785be88612d60 Mon Sep 17 00:00:00 2001 From: Trustin Lee Date: Mon, 11 Feb 2013 18:33:15 +0900 Subject: [PATCH] Prettify APIviz diagrams / Remove an empty package --- .../main/java/io/netty/buffer/ByteBuf.java | 1 + .../io/netty/buffer/ByteBufAllocator.java | 3 +++ .../main/java/io/netty/buffer/MessageBuf.java | 2 ++ .../java/io/netty/buffer/package-info.java | 7 +++++- .../netty/channel/udt/oio/package-info.java | 22 ------------------- .../io/netty/bootstrap/AbstractBootstrap.java | 1 + .../io/netty/bootstrap/ChannelFactory.java | 2 ++ .../java/io/netty/channel/ChannelConfig.java | 3 --- 8 files changed, 15 insertions(+), 26 deletions(-) delete mode 100644 transport-udt/src/main/java/io/netty/channel/udt/oio/package-info.java diff --git a/buffer/src/main/java/io/netty/buffer/ByteBuf.java b/buffer/src/main/java/io/netty/buffer/ByteBuf.java index 45596322ce..2ac22297cf 100644 --- a/buffer/src/main/java/io/netty/buffer/ByteBuf.java +++ b/buffer/src/main/java/io/netty/buffer/ByteBuf.java @@ -226,6 +226,7 @@ import java.nio.charset.UnsupportedCharsetException; * * Please refer to {@link ByteBufInputStream} and * {@link ByteBufOutputStream}. + * * @apiviz.landmark */ public interface ByteBuf extends Buf, Comparable { diff --git a/buffer/src/main/java/io/netty/buffer/ByteBufAllocator.java b/buffer/src/main/java/io/netty/buffer/ByteBufAllocator.java index 786bbb18f9..0d15bf495f 100644 --- a/buffer/src/main/java/io/netty/buffer/ByteBufAllocator.java +++ b/buffer/src/main/java/io/netty/buffer/ByteBufAllocator.java @@ -15,6 +15,9 @@ */ package io.netty.buffer; +/** + * @apiviz.has io.netty.buffer.ByteBuf oneway - - creates + */ public interface ByteBufAllocator { ByteBuf buffer(); diff --git a/buffer/src/main/java/io/netty/buffer/MessageBuf.java b/buffer/src/main/java/io/netty/buffer/MessageBuf.java index 37318ff8c2..4fa89c1dbf 100644 --- a/buffer/src/main/java/io/netty/buffer/MessageBuf.java +++ b/buffer/src/main/java/io/netty/buffer/MessageBuf.java @@ -22,6 +22,8 @@ import java.util.Queue; * Buf which operates on messages. * * @param the type of the messages that are hold by this {@link MessageBuf} + * + * @apiviz.landmark */ public interface MessageBuf extends Buf, Queue { diff --git a/buffer/src/main/java/io/netty/buffer/package-info.java b/buffer/src/main/java/io/netty/buffer/package-info.java index dbfbc93007..36bac15ccd 100644 --- a/buffer/src/main/java/io/netty/buffer/package-info.java +++ b/buffer/src/main/java/io/netty/buffer/package-info.java @@ -129,6 +129,11 @@ * * @apiviz.landmark * @apiviz.exclude ^java\.lang\. - * @apiviz.exclude ^java\.io\.[^\.]+Stream$ + * @apiviz.exclude netty\.((?!buffer).)+$ + * @apiviz.exclude (In|Out)putStream$ + * @apiviz.exclude \.(Abstract|Default)((?!ByteBufAllocator).)*$ + * @apiviz.exclude \.(BufType|BufUtil)$ + * @apiviz.exclude \.[^\.]+Exception$ + * @apiviz.exclude \.(Empty|Swapped|Default|Sliced|Duplicated|ReadOnly)[^\.]*ByteBuf$ */ package io.netty.buffer; diff --git a/transport-udt/src/main/java/io/netty/channel/udt/oio/package-info.java b/transport-udt/src/main/java/io/netty/channel/udt/oio/package-info.java deleted file mode 100644 index 00cc97d3c3..0000000000 --- a/transport-udt/src/main/java/io/netty/channel/udt/oio/package-info.java +++ /dev/null @@ -1,22 +0,0 @@ -/* - * Copyright 2012 The Netty Project - * - * The Netty Project licenses this file to you 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. - */ -/** - * UDT Transport for OIO Channels. - *

- * @see /netty/example/src/main/java/io/netty/example/udt - */ -package io.netty.channel.udt.oio; - diff --git a/transport/src/main/java/io/netty/bootstrap/AbstractBootstrap.java b/transport/src/main/java/io/netty/bootstrap/AbstractBootstrap.java index 41fcc67d4b..ca8b99290f 100644 --- a/transport/src/main/java/io/netty/bootstrap/AbstractBootstrap.java +++ b/transport/src/main/java/io/netty/bootstrap/AbstractBootstrap.java @@ -34,6 +34,7 @@ import java.util.Map; * {@link AbstractBootstrap} is a helper class that makes it easy to bootstrap a {@link Channel}. It support * method-chaining to provide an easy way to configure the {@link AbstractBootstrap}. * + * @apiviz.exclude */ abstract class AbstractBootstrap, C extends Channel> implements Cloneable { diff --git a/transport/src/main/java/io/netty/bootstrap/ChannelFactory.java b/transport/src/main/java/io/netty/bootstrap/ChannelFactory.java index 292eb6efa6..dd2f0647c1 100644 --- a/transport/src/main/java/io/netty/bootstrap/ChannelFactory.java +++ b/transport/src/main/java/io/netty/bootstrap/ChannelFactory.java @@ -20,6 +20,8 @@ import io.netty.channel.Channel; /** * Factory that creates a new {@link Channel} on {@link Bootstrap#bind()}, {@link Bootstrap#connect()}, and * {@link ServerBootstrap#bind()}. + * + * @apiviz.exclude */ public interface ChannelFactory { /** diff --git a/transport/src/main/java/io/netty/channel/ChannelConfig.java b/transport/src/main/java/io/netty/channel/ChannelConfig.java index ea0bcfb9ab..496f7ecd72 100644 --- a/transport/src/main/java/io/netty/channel/ChannelConfig.java +++ b/transport/src/main/java/io/netty/channel/ChannelConfig.java @@ -60,9 +60,6 @@ import java.util.Map; * example, you can configure the parameters which are specific to a TCP/IP * socket as explained in {@link SocketChannelConfig}. * - * @apiviz.has io.netty.channel.ChannelPipelineFactory - * @apiviz.composedOf io.netty.channel.ReceiveBufferSizePredictor - * * @apiviz.excludeSubtypes */ public interface ChannelConfig {