Author: miguel
Date: 2006-12-26 15:15:38 -0500 (Tue, 26 Dec 2006)
New Revision: 70093
Modified:
trunk/monodoc/class/System.Web/en/System.Web/HttpCookie.xml
Log:
Add HttpCookie docs
Modified: trunk/monodoc/class/System.Web/en/System.Web/HttpCookie.xml
===================================================================
--- trunk/monodoc/class/System.Web/en/System.Web/HttpCookie.xml 2006-12-26
20:13:39 UTC (rev 70092)
+++ trunk/monodoc/class/System.Web/en/System.Web/HttpCookie.xml 2006-12-26
20:15:38 UTC (rev 70093)
@@ -58,9 +58,9 @@
</Parameters>
<Docs>
<summary>Creates a cookie.</summary>
- <param name="name">To be added: an object of type 'string'</param>
- <returns>To be added: an object of type 'HttpCookie'</returns>
- <remarks>To be added</remarks>
+ <param name="name">The name of the cookie.</param>
+ <returns>The new cookie with the given name, and an empty
Value.</returns>
+ <remarks>The cookie is created with an empty value ("").</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@@ -77,7 +77,7 @@
</param>
<param name="value">The value of the cookie.</param>
<returns />
- <remarks>To be added</remarks>
+ <remarks>Creates a cookie with the given name and value.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
@@ -89,10 +89,10 @@
<Parameters>
</Parameters>
<Docs>
- <summary>To be added</summary>
- <param name="value">To be added: an object of type 'string'</param>
- <returns>To be added: an object of type 'string'</returns>
- <remarks>To be added</remarks>
+ <summary>The name for the cookie.</summary>
+ <param name="value">The new name for the cookie.</param>
+ <returns>The cookie name.</returns>
+ <remarks>Sets and resets the name of the cookie.</remarks>
</Docs>
</Member>
<Member MemberName="Path">
@@ -104,10 +104,14 @@
<Parameters>
</Parameters>
<Docs>
- <summary>To be added</summary>
- <param name="value">To be added: an object of type 'string'</param>
- <returns>To be added: an object of type 'string'</returns>
- <remarks>To be added</remarks>
+ <summary>The subset of URLs to which this cookie applies.</summary>
+ <param name="value">Sets the value of path.</param>
+ <returns>The current path value, by default it is "/".</returns>
+ <remarks>
+ <para>The Path attribute specifies the subset of URLs to which this
cookie applies.</para>
+ <para>The value for the Path attribute will be ignored is not a
prefix of the request-URI (see RFC 2109 for details).
+</para>
+ </remarks>
</Docs>
</Member>
<Member MemberName="Secure">
@@ -134,10 +138,43 @@
<Parameters>
</Parameters>
<Docs>
- <summary>To be added</summary>
- <param name="value">To be added: an object of type 'string'</param>
- <returns>To be added: an object of type 'string'</returns>
- <remarks>To be added</remarks>
+ <summary>The domain for which the cookie is valid.</summary>
+ <param name="value">The domain. RFC 2109 requires that a domain must
always start with a dot.</param>
+ <returns>The current value of the domain. The default value is
null.</returns>
+ <remarks>
+ <para>This is an optional parameter for cookies, and by default the
value of this property is null.
+</para>
+ <list type="bullet">
+ <item>
+ <term> The value for the Path attribute is not a prefix of the
request-
+ URI.</term>
+ </item>
+ <item>
+ <term>The value for the Domain attribute contains no embedded
dots or does not start with a dot.</term>
+ </item>
+ <item>
+ <term>The value for the request-host does not domain-match the
Domain attribute.</term>
+ </item>
+ <item>
+ <term>The request-host is a FQDN (not IP address) and has the
form HD, where D is the value of the Domain attribute, and H is a string that
contains one or more dots.</term>
+ </item>
+ </list>
+ <para> Examples:</para>
+ <list type="bullet">
+ <item>
+ <term>A Set-Cookie from request-host y.x.foo.com for
Domain=.foo.com would be rejected, because H is y.x and contains a dot.</term>
+ </item>
+ <item>
+ <term>A Set-Cookie from request-host x.foo.com for
Domain=.foo.com would be accepted.</term>
+ </item>
+ <item>
+ <term>A Set-Cookie with Domain=.com or Domain=.com., will always
be rejected, because there is no embedded dot.</term>
+ </item>
+ <item>
+ <term>A Set-Cookie with Domain=ajax.com will be rejected because
the value for Domain does not begin with a dot.</term>
+ </item>
+ </list>
+ </remarks>
</Docs>
</Member>
<Member MemberName="Expires">
@@ -164,10 +201,10 @@
<Parameters>
</Parameters>
<Docs>
- <summary>To be added</summary>
- <param name="value">To be added: an object of type 'string'</param>
- <returns>To be added: an object of type 'string'</returns>
- <remarks>To be added</remarks>
+ <summary>The value of the cookie.</summary>
+ <param name="value">The new value to set for the cookie.</param>
+ <returns>The current value stored in the cookie.</returns>
+ <remarks>The current cookie value, this does not include any other
properties, for those you must use the property accessors.</remarks>
</Docs>
</Member>
<Member MemberName="HasKeys">
@@ -177,7 +214,7 @@
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added</summary>
+ <summary>Whether any key/value pairs have been set on the
cookie.</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
_______________________________________________
Mono-patches maillist - [email protected]
http://lists.ximian.com/mailman/listinfo/mono-patches
