Author: markt
Date: Fri Oct 16 08:34:07 2015
New Revision: 1708914
URL: http://svn.apache.org/viewvc?rev=1708914&view=rev
Log:
Fix javadoc warnings
Modified:
tomcat/trunk/java/org/apache/tomcat/util/http/CookieProcessor.java
Modified: tomcat/trunk/java/org/apache/tomcat/util/http/CookieProcessor.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/tomcat/util/http/CookieProcessor.java?rev=1708914&r1=1708913&r2=1708914&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/tomcat/util/http/CookieProcessor.java
(original)
+++ tomcat/trunk/java/org/apache/tomcat/util/http/CookieProcessor.java Fri Oct
16 08:34:07 2015
@@ -24,17 +24,28 @@ public interface CookieProcessor {
/**
* Parse the provided headers into server cookie objects.
+ *
+ * @param headers The HTTP headers to parse
+ * @param serverCookies The server cookies object to populate with the
+ * results of the parsing
*/
void parseCookieHeader(MimeHeaders headers, ServerCookies serverCookies);
/**
- * Generate the HTTP header value for the given Cookie.
+ * Generate the {@code Set-Cookie} HTTP header value for the given Cookie.
+ *
+ * @param cookie The cookie for which the header will be generated
+ *
+ * @return The header value in a form that can be added directly to the
+ * response
*/
String generateHeader(Cookie cookie);
/**
- * The character set that will be used when converting between bytes and
- * characters when parsing and/or generating HTTP headers for cookies.
+ * Obtain the character set that will be used when converting between bytes
+ * and characters when parsing and/or generating HTTP headers for cookies.
+ *
+ * @return The character set used for byte<->character conversions
*/
Charset getCharset();
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
