Skip to content

Commit

Permalink
Remove apiviz tags - we are focusing on user guide instead and puttin…
Browse files Browse the repository at this point in the history
…g diagrams there
  • Loading branch information
trustin committed Feb 14, 2013
1 parent 6201fb9 commit 1011227
Show file tree
Hide file tree
Showing 113 changed files with 8 additions and 299 deletions.
2 changes: 0 additions & 2 deletions buffer/src/main/java/io/netty/buffer/ByteBuf.java
Original file line number Diff line number Diff line change
Expand Up @@ -226,8 +226,6 @@
*
* Please refer to {@link ByteBufInputStream} and
* {@link ByteBufOutputStream}.
*
* @apiviz.landmark
*/
public interface ByteBuf extends Buf, Comparable<ByteBuf> {

Expand Down
3 changes: 0 additions & 3 deletions buffer/src/main/java/io/netty/buffer/ByteBufAllocator.java
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,6 @@
*/
package io.netty.buffer;

/**
* @apiviz.has io.netty.buffer.ByteBuf oneway - - creates
*/
public interface ByteBufAllocator {

ByteBuf buffer();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
* refer to {@link ByteBuf#indexOf(int, int, ByteBufIndexFinder)} and
* {@link ByteBuf#bytesBefore(int, int, ByteBufIndexFinder)}
* for more explanation.
* @apiviz.uses io.netty.buffer.ByteBuf
*/
public interface ByteBufIndexFinder {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@
* This stream implements {@link DataInput} for your convenience.
* 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.ByteBuf
*/
public class ByteBufInputStream extends InputStream implements DataInput {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
* This stream implements {@link DataOutput} for your convenience.
* 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.ByteBuf
*/
public class ByteBufOutputStream extends OutputStream implements DataOutput {

Expand Down
2 changes: 0 additions & 2 deletions buffer/src/main/java/io/netty/buffer/MessageBuf.java
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,6 @@
* Buf which operates on messages.
*
* @param <T> the type of the messages that are hold by this {@link MessageBuf}
*
* @apiviz.landmark
*/
public interface MessageBuf<T> extends Buf, Queue<T> {

Expand Down
2 changes: 0 additions & 2 deletions buffer/src/main/java/io/netty/buffer/Unpooled.java
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,6 @@
* This class also provides various utility methods to help implementation
* of a new buffer type, generation of hex dump and swapping an integer's
* byte order.
* @apiviz.landmark
* @apiviz.has io.netty.buffer.Buf oneway - - creates
*/
public final class Unpooled {

Expand Down
9 changes: 0 additions & 9 deletions buffer/src/main/java/io/netty/buffer/package-info.java
Original file line number Diff line number Diff line change
Expand Up @@ -126,14 +126,5 @@
* easier for a JVM to optimize the buffer access. More complicated buffer
* implementation is used only for sliced or composite buffers, and it performs
* as well as {@link java.nio.ByteBuffer}.
*
* @apiviz.landmark
* @apiviz.exclude ^java\.lang\.
* @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;
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,6 @@
* </pre>
*
* @see CookieDecoder
*
* @apiviz.stereotype utility
* @apiviz.has io.netty.handler.codec.http.Cookie oneway - - encodes
*/
public final class ClientCookieEncoder {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,6 @@
*
* @see ClientCookieEncoder
* @see ServerCookieEncoder
*
* @apiviz.stereotype utility
* @apiviz.has io.netty.handler.codec.http.Cookie oneway - - decodes
*/
public final class CookieDecoder {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,6 @@
* a {@link PrematureChannelClosureException} is thrown.
*
* @see HttpServerCodec
*
* @apiviz.has io.netty.handler.codec.http.HttpResponseDecoder
* @apiviz.has io.netty.handler.codec.http.HttpRequestEncoder
*/
public final class HttpClientCodec
extends CombinedChannelDuplexHandler
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
* is 'chunked. If you prefer not to receive {@link HttpContent} in your handler,
* place {@link HttpObjectAggregator} after {@link HttpObjectDecoder} in the
* {@link ChannelPipeline}.
* @apiviz.landmark
*/
public interface HttpContent extends HttpObject, ByteBufHolder {
@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,6 @@
/**
* Provides the constants for the standard HTTP header names and values and
* commonly used utility methods that accesses an {@link HttpMessage}.
* @apiviz.landmark
* @apiviz.stereotype static
*/
public abstract class HttpHeaders implements Iterable<Map.Entry<String, String>> {

Expand Down Expand Up @@ -102,11 +100,7 @@ public Iterator<Entry<String, String>> iterator() {
};

/**
* Standard and CORS HTTP header names.
* For CORS headers, see
* https://developer.mozilla.org/en-US/docs/HTTP_access_control
*
* @apiviz.stereotype static
* Standard HTTP header names.
*/
public static final class Names {
/**
Expand Down Expand Up @@ -408,7 +402,6 @@ private Names() {

/**
* Standard HTTP header values.
* @apiviz.stereotype static
*/
public static final class Values {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,10 @@
/**
* An interface that defines a HTTP message, providing common properties for
* {@link HttpRequest} and {@link HttpResponse}.
*
* @see HttpResponse
* @see HttpRequest
* @see HttpHeaders
*
* @apiviz.landmark
* @apiviz.has io.netty.handler.codec.http.HttpContent oneway - - is followed by
*/
public interface HttpMessage extends HttpObject {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
* The request getMethod of HTTP or its derived protocols, such as
* <a href="http://en.wikipedia.org/wiki/Real_Time_Streaming_Protocol">RTSP</a> and
* <a href="http://en.wikipedia.org/wiki/Internet_Content_Adaptation_Protocol">ICAP</a>.
* @apiviz.exclude
*/
public class HttpMethod implements Comparable<HttpMethod> {
/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,6 @@
* p.addLast("encoder", new {@link HttpResponseEncoder}());
* p.addLast("handler", new HttpRequestHandler());
* </pre>
* @apiviz.landmark
* @apiviz.has io.netty.handler.codec.http.HttpContent oneway - - filters out
*/
public class HttpObjectAggregator extends MessageToMessageDecoder<HttpObject> {
public static final int DEFAULT_MAX_COMPOSITEBUFFER_COMPONENTS = 1024;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,6 @@
* <a href="http://en.wikipedia.org/wiki/Internet_Content_Adaptation_Protocol">ICAP</a>.
* To implement the decoder of such a derived protocol, extend this class and
* implement all abstract methods properly.
* @apiviz.landmark
*/
public abstract class HttpObjectDecoder extends ReplayingDecoder<HttpObjectDecoder.State> {

Expand All @@ -112,9 +111,8 @@ public abstract class HttpObjectDecoder extends ReplayingDecoder<HttpObjectDecod
/**
* The internal state of {@link HttpObjectDecoder}.
* <em>Internal use only</em>.
* @apiviz.exclude
*/
protected enum State {
enum State {
SKIP_CONTROL_CHARS,
READ_INITIAL,
READ_HEADER,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@
* <a href="http://en.wikipedia.org/wiki/Internet_Content_Adaptation_Protocol">ICAP</a>.
* To implement the encoder of such a derived protocol, extend this class and
* implement all abstract methods properly.
* @apiviz.landmark
*/
public abstract class HttpObjectEncoder<H extends HttpMessage> extends MessageToByteEncoder<HttpObject> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
* The response code and its description of HTTP or its derived protocols, such as
* <a href="http://en.wikipedia.org/wiki/Real_Time_Streaming_Protocol">RTSP</a> and
* <a href="http://en.wikipedia.org/wiki/Internet_Content_Adaptation_Protocol">ICAP</a>.
* @apiviz.exclude
*/
public class HttpResponseStatus implements Comparable<HttpResponseStatus> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,8 @@
/**
* A combination of {@link HttpRequestDecoder} and {@link HttpResponseEncoder}
* which enables easier server side HTTP implementation.
* @see HttpClientCodec
*
* @apiviz.has io.netty.handler.codec.http.HttpRequestDecoder
* @apiviz.has io.netty.handler.codec.http.HttpResponseEncoder
* @see HttpClientCodec
*/
public final class HttpServerCodec
extends CombinedChannelDuplexHandler
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@
* The version of HTTP or its derived protocols, such as
* <a href="http://en.wikipedia.org/wiki/Real_Time_Streaming_Protocol">RTSP</a> and
* <a href="http://en.wikipedia.org/wiki/Internet_Content_Adaptation_Protocol">ICAP</a>.
* @apiviz.exclude
*/
public class HttpVersion implements Comparable<HttpVersion> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,6 @@
* integer parameter.
*
* @see QueryStringEncoder
*
* @apiviz.stereotype utility
* @apiviz.has io.netty.handler.codec.http.HttpRequest oneway - - decodes URI
*/
public class QueryStringDecoder {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,6 @@
* assert encoder.toString().equals("/hello?recipient=world");
* </pre>
* @see QueryStringDecoder
*
* @apiviz.stereotype utility
* @apiviz.has io.netty.handler.codec.http.HttpRequest oneway - - encodes URI
*/
public class QueryStringEncoder {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,6 @@
* </pre>
*
* @see CookieDecoder
*
* @apiviz.stereotype utility
* @apiviz.has io.netty.handler.codec.http.Cookie oneway - - encodes
*/
public final class ServerCookieEncoder {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,5 @@

/**
* Encoder, decoder and their related message types for HTTP.
*
* @apiviz.exclude ^java\.lang\.
* @apiviz.exclude \.HttpHeaders\.
* @apiviz.exclude \.codec\.replay\.
* @apiviz.exclude \.(Simple)?Channel[A-Za-z]*Handler$
* @apiviz.exclude \.Rtsp
* @apiviz.exclude \.Default
* @apiviz.exclude \.Http(Client|Server)Codec$
*/
package io.netty.handler.codec.http;
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,6 @@

/**
* Creates a new {@link WebSocketClientHandshaker} of desired protocol version.
*
* @apiviz.landmark
* @apiviz.has io.netty.handler.codec.http.websocketx.WebSocketClientHandshaker oneway - - creates
*/
public final class WebSocketClientHandshakerFactory {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,6 @@
/**
* Auto-detects the version of the Web Socket protocol in use and creates a new proper
* {@link WebSocketServerHandshaker}.
*
* @apiviz.landmark
* @apiviz.has io.netty.handler.codec.http.websocketx.WebSocketServerHandshaker oneway - - creates
*/
public class WebSocketServerHandshakerFactory {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,6 @@
* server, take a look into the <tt>WebSocketServerX</tt> example located in the
* {@code io.netty.example.http.websocket} package.
* </p>
*
* @apiviz.exclude [0-9][0-9]
* @apiviz.exclude Exception$
* @apiviz.exclude Version$
*/
package io.netty.handler.codec.http.websocketx;

Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@

/**
* Standard RTSP header names and values.
* @apiviz.exclude
* @apiviz.stereotype static
*/
public final class RtspHeaders {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@

/**
* The request getMethod of RTSP.
* @apiviz.exclude
*/
public final class RtspMethods {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@
* value, a {@link TooLongFrameException} will be raised.</td>
* </tr>
* </table>
* @apiviz.landmark
*/
public abstract class RtspObjectDecoder extends HttpObjectDecoder {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,6 @@
/**
* Encodes an RTSP message represented in {@link FullHttpMessage} into
* a {@link ByteBuf}.
*
* @apiviz.landmark
*/
@Sharable
public abstract class RtspObjectEncoder<H extends HttpMessage> extends HttpObjectEncoder<H> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@

/**
* The getStatus code and its description of a RTSP response.
* @apiviz.exclude
*/
public final class RtspResponseStatuses {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@

/**
* The version of RTSP.
* @apiviz.exclude
*/
public final class RtspVersions {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,5 @@
/**
* An <a href="http://en.wikipedia.org/wiki/Real_Time_Streaming_Protocol">RTSP</a>
* extension based on the HTTP codec.
*
* @apiviz.exclude \.RtspHeaders\.
*/
package io.netty.handler.codec.rtsp;
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,6 @@

/**
* A combination of {@link SpdyFrameDecoder} and {@link SpdyFrameEncoder}.
*
* @apiviz.has io.netty.handler.codec.spdy.SpdyFrameDecoder
* @apiviz.has io.netty.handler.codec.spdy.SpdyFrameEncoder
*/
public final class SpdyFrameCodec
extends CombinedChannelDuplexHandler
Expand Down
Loading

0 comments on commit 1011227

Please sign in to comment.