From a818cad45ab9713a93bf2f813e1521be61adc500 Mon Sep 17 00:00:00 2001 From: Cruz Julian Bishop Date: Fri, 29 Jun 2012 16:37:40 +1000 Subject: [PATCH] Make HttpRequest's documentation easier to read --- .../io/netty/handler/codec/http/HttpRequest.java | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/codec-http/src/main/java/io/netty/handler/codec/http/HttpRequest.java b/codec-http/src/main/java/io/netty/handler/codec/http/HttpRequest.java index a6cfe6a1b3..6a4db17da4 100644 --- a/codec-http/src/main/java/io/netty/handler/codec/http/HttpRequest.java +++ b/codec-http/src/main/java/io/netty/handler/codec/http/HttpRequest.java @@ -34,22 +34,30 @@ package io.netty.handler.codec.http; public interface HttpRequest extends HttpMessage { /** - * Returns the method of this request. + * Gets the {@link HttpMethod} of this {@link HttpRequest}. + * + * @return The {@link HttpMethod} of this {@link HttpRequest} */ HttpMethod getMethod(); /** - * Sets the method of this request. + * Sets the {@link HttpMethod} of this {@link HttpRequest}. + * + * @param The {@link HttpMethod} to set */ void setMethod(HttpMethod method); /** - * Returns the URI (or path) of this request. + * Gets the requested URI (or alternatively, path) + * + * @return The URI being requested */ String getUri(); /** - * Sets the URI (or path) of this request. + * Sets the URI (or alternatively, path) being requested. + * + * @param uri The URI being requested */ void setUri(String uri); }