Changed "Gets the" to "Returns the" - Requested by @trustin

This commit is contained in:
Cruz Julian Bishop 2012-06-29 19:25:31 +10:00
parent f3fff2d3e8
commit 3792693468
4 changed files with 14 additions and 14 deletions

View File

@ -24,14 +24,14 @@ import java.util.Set;
public interface Cookie extends Comparable<Cookie> { public interface Cookie extends Comparable<Cookie> {
/** /**
* Gets the name of this {@link Cookie}. * Returns the name of this {@link Cookie}.
* *
* @return The name of this {@link Cookie} * @return The name of this {@link Cookie}
*/ */
String getName(); String getName();
/** /**
* Gets the value of this {@link Cookie}. * Returns the value of this {@link Cookie}.
* *
* @return The value of this {@link Cookie} * @return The value of this {@link Cookie}
*/ */
@ -45,7 +45,7 @@ public interface Cookie extends Comparable<Cookie> {
void setValue(String value); void setValue(String value);
/** /**
* Gets the domain of this {@link Cookie}. * Returns the domain of this {@link Cookie}.
* *
* @return The domain of this {@link Cookie} * @return The domain of this {@link Cookie}
*/ */
@ -59,7 +59,7 @@ public interface Cookie extends Comparable<Cookie> {
void setDomain(String domain); void setDomain(String domain);
/** /**
* Gets the path of this {@link Cookie}. * Returns the path of this {@link Cookie}.
* *
* @return The {@link Cookie}'s path * @return The {@link Cookie}'s path
*/ */
@ -73,7 +73,7 @@ public interface Cookie extends Comparable<Cookie> {
void setPath(String path); void setPath(String path);
/** /**
* Gets the comment of this {@link Cookie}. * Returns the comment of this {@link Cookie}.
* *
* @return The comment of this {@link Cookie} * @return The comment of this {@link Cookie}
*/ */
@ -87,7 +87,7 @@ public interface Cookie extends Comparable<Cookie> {
void setComment(String comment); void setComment(String comment);
/** /**
* Gets the maximum age of this {@link Cookie} in seconds. * Returns the maximum age of this {@link Cookie} in seconds.
* *
* @return The maximum age of this {@link Cookie} * @return The maximum age of this {@link Cookie}
*/ */
@ -105,7 +105,7 @@ public interface Cookie extends Comparable<Cookie> {
void setMaxAge(long maxAge); void setMaxAge(long maxAge);
/** /**
* Gets the version of this {@link Cookie}. * Returns the version of this {@link Cookie}.
* *
* @return The version of this {@link Cookie} * @return The version of this {@link Cookie}
*/ */
@ -154,7 +154,7 @@ public interface Cookie extends Comparable<Cookie> {
void setHttpOnly(boolean httpOnly); void setHttpOnly(boolean httpOnly);
/** /**
* Gets the comment URL of this {@link Cookie}. * Returns the comment URL of this {@link Cookie}.
* *
* @return The comment URL of this {@link Cookie} * @return The comment URL of this {@link Cookie}
*/ */

View File

@ -37,7 +37,7 @@ import java.util.Set;
public interface HttpMessage { public interface HttpMessage {
/** /**
* Gets the value of a header with the specified name. If there are * Returns the value of a header with the specified name. If there are
* more than one values for the specified name, the first value is returned. * more than one values for the specified name, the first value is returned.
* *
* @param name The name of the header to search * @param name The name of the header to search
@ -78,7 +78,7 @@ public interface HttpMessage {
Set<String> getHeaderNames(); Set<String> getHeaderNames();
/** /**
* Gets the protocol version of this {@link HttpMessage} * Returns the protocol version of this {@link HttpMessage}
* *
* @returns The protocol version * @returns The protocol version
*/ */
@ -92,7 +92,7 @@ public interface HttpMessage {
void setProtocolVersion(HttpVersion version); void setProtocolVersion(HttpVersion version);
/** /**
* Gets the content of this {@link HttpMessage}. * Returns the content of this {@link HttpMessage}.
* *
* If there is no content or {@link #isChunked()} returns {@code true}, * If there is no content or {@link #isChunked()} returns {@code true},
* an {@link Unpooled#EMPTY_BUFFER} is returned. * an {@link Unpooled#EMPTY_BUFFER} is returned.

View File

@ -34,7 +34,7 @@ package io.netty.handler.codec.http;
public interface HttpRequest extends HttpMessage { public interface HttpRequest extends HttpMessage {
/** /**
* Gets the {@link HttpMethod} of this {@link HttpRequest}. * Returns the {@link HttpMethod} of this {@link HttpRequest}.
* *
* @return The {@link HttpMethod} of this {@link HttpRequest} * @return The {@link HttpMethod} of this {@link HttpRequest}
*/ */
@ -48,7 +48,7 @@ public interface HttpRequest extends HttpMessage {
void setMethod(HttpMethod method); void setMethod(HttpMethod method);
/** /**
* Gets the requested URI (or alternatively, path) * Returns the requested URI (or alternatively, path)
* *
* @return The URI being requested * @return The URI being requested
*/ */

View File

@ -32,7 +32,7 @@ package io.netty.handler.codec.http;
public interface HttpResponse extends HttpMessage { public interface HttpResponse extends HttpMessage {
/** /**
* Gets the status of this {@link HttpResponse}. * Returns the status of this {@link HttpResponse}.
* *
* @return The {@link HttpResponseStatus} of this {@link HttpResponse} * @return The {@link HttpResponseStatus} of this {@link HttpResponse}
*/ */